Breadcrumbs

Position List API

API Support: https://help.veson.com/q88/ URL: https://api.q88.com/

This API provides access to Position List data available within the Position List Platform. The API is accessible on the following base URL: https://api.q88.com/.

Services and schema API documentation: https://api.q88.com/swagger/index.html


Introduction

The API allows for programmatic access to Position List data resources that are also accessible in the Position List browser and mobile application. Position list uses JSON as the serialisation mechanism for both requests and response. The response is compressed using GZIP before sending back to the user. Users will only be able to access their private data and data that has been shared with them; this is determined by the organisation specific authentication token.

Position List resources are grouped into the following categories:

  • Cargoes and fixtures - time charter and cargoes and fixtures data.

  • Fleet - data regarding changes to fleets

  • Positions - modification and calling of open positional data


Authentication

Authentication to the Position List API is done through bearer token. To make calls to the API, send the API token in the Authorization HTTP header using the Bearer authentication scheme. Please contact https://help.veson.com/q88/ or you account manager for you bearer token to be set-up and shared with you. Access tokens should be provided as a bearer token, e.g. it should be in the form of a header with the following format:

Authorization: Bearer <Token>

Base URL

Base URL:

https://api.q88.com/


Services and Schema API documentation

Position List product APIs are documented in Swagger, with each of the following APIs described. This can be found through the following link: https://api.q88.com/swagger/index.html

FixturesService

  • CargoesAndFixtures - retrieves lists of private and shared cargoes and fixtures

  • TimeCharterers- retrieves lists of Time Charters

FleetService

  • GetFleetChange - gain visibility of how vessels are changing between fleets

PositionService

  • GetVessels - returns high-level vessel details

  • GetPorts - returns high-level port details

  • ModifyPosition - update the open position for a vessel based on your market information

  • GetPositionList - call open positions that your organisation have entered or had shared with them

  • GetVesselPositionHistory - retrieves open positions entered between a given date range, for an individual vessel

  • GetPositionListBySavedSearch - create a position search through the Position List browser, name the search and save it, and then retrieve the same open positions that would return via browser, but directly through API.

Schemas

  • CargoesAndFixturesRequest

  • DataOrder

  • Fixture

  • FixtureFilter

  • FixturesRequest

  • FleetChangeItem

  • ModifyPositionListRequest

  • ModifyPositionListResponse

  • Order

  • Port

  • PositionListItem

  • SavedSearchNameRequest

  • SearchCriteriaRequest

  • TimeCharterer

  • Vessel

  • VesselSearchCriteriaRequest