{"info":{"_postman_id":"985f7793-96da-4e8a-bcb2-b0ee9806bf8b","name":"Drewry Data API Documentation","description":"

General Information

\n

\n You can find general information here:\n \n https://github.com/freight-trust/developers/\n \n

\n\n

Maintenance Window

\n

\n No maintenance scheduled.\n

\n\n

URLs

\n\n

API Base URL is https://api.containerfreightindex.com.

\n

Full URL example: https://api.containerfreightindex.com/v1.0/contracts/

\n

Versioning

\n

\n The API is versioned using a version tag in the URL (e.g. /v1.0/). Breaking changes\n are deployed with an incremented API version. Older versions may be marked\n deprecated and be shutdown.\n

\n\n

HTTP Statuses

\n\n

This API uses conventional HTTP response codes to indicate the success or failure of an API request.

\n

In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.

\n

Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.

\n

If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.

\n

Here is a list of supported codes:

\n\n\n

Responses and Data Format

\n\n

When a request is successful, a response body will be sent back in the form of a JSON object or an array of JSON objects, under the data key. Our API only supports JSON format.

\n

In the event of a problem, the body of the response will usually contain additionalinformation about the problem that was encountered, under the errors key.

\n

Authentication

\n\n

In order to interact with the DrewryAPI, your application must authenticate.

\n

The Drewry API handles this through OAuth, an open standard for\nauthorization, with a two-legged Oauth 2 approach (using client credentials).

\n

An access token is needed to authenticate your application for every endpoint.

\n

How to get an Access Token with OAuth 2?

\n\n

Use the https://api.freighttrust.com/oauth/token/ endpoint with your\ncredentials to receive a token. The necessary client_id and\nclient_secret credentials are provided by Drewry. Please contact us at\nadmin@freighttrust.com to request them.

\n

Because of this, it is absolutely essential that you keep your client_id\nand client_secret credentials secure.

\n

A token is valid for 30 minutes. After that, you can either refresh it or create a new\none.

\n

How to Authenticate with your Access Token?

\n\n

In order to make an authenticated request, include a bearer-type Authorization header\ncontaining your OAuth token. All requests must be made over HTTPS.

\n

For example: Authorization: Bearer YOUR-TOKEN

\n

Usage Plans

\n

\n There are measurements in place to protect the API from abuse. This includes a\n request quota and throttling using the token-bucket pattern, which can be configured\n to the needs of the external service. Every request is counted against your usage\n plan. The default usage plan is as follows.\n

\n\n\n\n

Code Samples:

\n\n\n \n\n\n View samples on GitHub\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9323065","collectionId":"985f7793-96da-4e8a-bcb2-b0ee9806bf8b","publishedId":"T17M7R9P","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-10T18:39:18.000Z"},"item":[{"name":"v1.0","item":[{"name":"contracts","item":[{"name":"{contract ticker symbol}","item":[{"name":"price-releases","item":[{"name":"Read Price Releases","id":"fb7252cb-e284-4d8c-85a7-99c98930b787","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/contracts/:contract_ticker_symbol/price-releases/","description":"

For a specific contract, this endpoint returns all the Price Releases you can\naccess according to your current subscription.

\n

Drewry releases (publishes) prices several times per week, which is called\nPrice Release. Please read our Methodology and Specifications Guide for more details.

\n

Data Revision Policy

\n

Drewry will on occasion publish corrections to price assessments after the\npublication date. These errors may arise from clerical mistakes or miscalculation\nerrors amongst other reasons. Any changes or revisions will take place\nwithin two working days following the closing of the submission window. Drewry\nwill send a notification of any changes to its previous assessments via email to all\nusers with an explanation as to why a correction was implemented.

\n","urlObject":{"path":["v1.0","contracts",":contract_ticker_symbol","price-releases",""],"host":["/"],"query":[],"variable":[{"id":"e3a2050e-12fe-458a-b1de-92bcf5b4c2b8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"","key":"contract_ticker_symbol"}]}},"response":[{"id":"58b96cab-dd9a-40bb-ae98-5002f421961a","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": [\n {\n \"id\": -78545487,\n \"contractId\": \"\",\n \"releaseDate\": \"1960-07-30\",\n \"publishedAt\": \"1983-11-13T09:35:45.242Z\",\n \"assessmentWindowClosedAt\": \"1956-11-16T13:43:56.442Z\",\n \"assessmentWindowOpenedAt\": \"1962-09-05T07:47:17.323Z\",\n \"data\": [\n {\n \"revisionNumber\": -59876582,\n \"revisionPublishedAt\": \"1941-08-05T18:28:38.366Z\",\n \"dataPoints\": [\n {\n \"index\": 19532280,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"2016-02-05\",\n \"endAt\": \"1947-08-21\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -85195431.57117751,\n \"unit\": \"usdPerDay\"\n }\n },\n {\n \"index\": -32136440,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1962-02-26\",\n \"endAt\": \"1942-11-22\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -41020215.75973875,\n \"unit\": \"usdPerDay\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": 75186804\n }\n },\n {\n \"revisionNumber\": 2739818,\n \"revisionPublishedAt\": \"1996-05-22T02:39:25.060Z\",\n \"dataPoints\": [\n {\n \"index\": -7243873,\n \"deliveryPeriod\": {\n \"type\": \"month\",\n \"startAt\": \"1968-09-22\",\n \"endAt\": \"1985-04-02\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -36879023.976967715,\n \"unit\": \"usdPerDay\"\n }\n },\n {\n \"index\": -49554487,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"2018-12-14\",\n \"endAt\": \"1991-12-22\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 60624300.72421846,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": -77564202\n }\n }\n ],\n \"previousPriceRelease\": {\n \"id\": 83637061,\n \"releaseDate\": \"1969-02-12\"\n },\n \"nextPriceRelease\": {\n \"id\": -58546312,\n \"releaseDate\": \"1979-12-23\"\n }\n },\n {\n \"id\": 16202008,\n \"contractId\": \"\",\n \"releaseDate\": \"1957-01-29\",\n \"publishedAt\": \"1942-01-18T14:22:05.283Z\",\n \"assessmentWindowClosedAt\": \"1959-08-02T10:13:50.677Z\",\n \"assessmentWindowOpenedAt\": \"1993-01-20T00:29:19.176Z\",\n \"data\": [\n {\n \"revisionNumber\": 96098206,\n \"revisionPublishedAt\": \"1947-10-09T12:03:52.953Z\",\n \"dataPoints\": [\n {\n \"index\": 27228994,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1979-10-30\",\n \"endAt\": \"1949-08-26\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -91393823.80728169,\n \"unit\": \"usdPerMMBtu\"\n }\n },\n {\n \"index\": 92204017,\n \"deliveryPeriod\": {\n \"type\": \"month\",\n \"startAt\": \"1964-05-18\",\n \"endAt\": \"1990-10-17\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 92873121.57121268,\n \"unit\": \"usdPerDay\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": 75698341\n }\n },\n {\n \"revisionNumber\": 27305627,\n \"revisionPublishedAt\": \"2019-11-12T10:45:25.036Z\",\n \"dataPoints\": [\n {\n \"index\": -17615969,\n \"deliveryPeriod\": {\n \"type\": \"month\",\n \"startAt\": \"1980-05-20\",\n \"endAt\": \"2015-06-09\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 77550243.11117893,\n \"unit\": \"usdPerDay\"\n }\n },\n {\n \"index\": 67261284,\n \"deliveryPeriod\": {\n \"type\": \"months\",\n \"startAt\": \"1959-06-18\",\n \"endAt\": \"2005-05-02\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 90798470.35036236,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": 4626064\n }\n }\n ],\n \"previousPriceRelease\": {\n \"id\": -91203109,\n \"releaseDate\": \"1952-06-15\"\n },\n \"nextPriceRelease\": {\n \"id\": 82022500,\n \"releaseDate\": \"1941-02-24\"\n }\n }\n ]\n}"},{"id":"8d24b824-b291-4149-a9af-0fd172af168b","name":"Validation Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"fb7252cb-e284-4d8c-85a7-99c98930b787"},{"name":"Read First Price Release","id":"0bac7818-7a5b-490e-aaf0-aba917fd1e64","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/contracts/:contract_ticker_symbol/price-releases/first/","description":"

For a specific contract, this endpoint returns the first Price Releases if,\naccording to your current subscription, you can access it.

\n

Drewry releases (publishes) prices several times per week, which is called\nPrice Release. Please read our Methodology and Specifications Guide for more details.

\n

Data Revision Policy

\n

Drewry will on occasion publish corrections to price assessments after the\npublication date. These errors may arise from clerical mistakes or miscalculation\nerrors amongst other reasons. Any changes or revisions will take place\nwithin two working days following the closing of the submission window. Drewry\nwill send a notification of any changes to its previous assessments via email to all\nusers with an explanation as to why a correction was implemented.

\n","urlObject":{"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","first",""],"host":["/"],"query":[],"variable":[{"id":"70f9be56-2c1d-4f5b-95a8-96af77ea7f8d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"","key":"contract_ticker_symbol"}]}},"response":[{"id":"3c60e63e-c145-4b40-a538-be6e70eb8f31","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/first/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","first",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": {\n \"id\": 35557930,\n \"contractId\": \"\",\n \"releaseDate\": \"1988-04-26\",\n \"publishedAt\": \"1947-09-19T07:29:39.516Z\",\n \"assessmentWindowClosedAt\": \"2006-04-28T19:11:22.776Z\",\n \"assessmentWindowOpenedAt\": \"1988-10-02T23:00:06.225Z\",\n \"data\": [\n {\n \"revisionNumber\": 53409894,\n \"revisionPublishedAt\": \"1982-02-19T09:05:59.262Z\",\n \"dataPoints\": [\n {\n \"index\": -22320674,\n \"deliveryPeriod\": {\n \"type\": \"months\",\n \"startAt\": \"1977-03-19\",\n \"endAt\": \"1989-10-27\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 97461170.93443361,\n \"unit\": \"usdPerMMBtu\"\n }\n },\n {\n \"index\": -65364083,\n \"deliveryPeriod\": {\n \"type\": \"month\",\n \"startAt\": \"1971-04-06\",\n \"endAt\": \"1954-04-12\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 35836024.50017983,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": -8288613\n }\n },\n {\n \"revisionNumber\": 34470567,\n \"revisionPublishedAt\": \"1968-01-19T05:37:06.519Z\",\n \"dataPoints\": [\n {\n \"index\": 22842210,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1966-10-29\",\n \"endAt\": \"1952-05-30\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 37205338.22278163,\n \"unit\": \"usdPerMMBtu\"\n }\n },\n {\n \"index\": -68479354,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1996-09-05\",\n \"endAt\": \"1948-03-25\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -23883478.841887966,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": -51927474\n }\n }\n ],\n \"previousPriceRelease\": {\n \"id\": 36367448,\n \"releaseDate\": \"1955-04-21\"\n },\n \"nextPriceRelease\": {\n \"id\": 69544519,\n \"releaseDate\": \"1970-09-30\"\n }\n }\n}"},{"id":"8613ea57-f9ad-46f0-9533-aea4b6979f66","name":"Validation Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/first/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","first",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"0bac7818-7a5b-490e-aaf0-aba917fd1e64"},{"name":"Read Latest Price Release","id":"9577ce1a-60f2-4878-a1b6-c7b4e1410b29","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/contracts/:contract_ticker_symbol/price-releases/latest/","description":"

For a specific contract, this endpoint returns the latest Price Releases if,\naccording to your current subscription, you can access it.

\n

Drewry releases (publishes) prices several times per week, which is called\nPrice Release. Please read our Methodology and Specifications Guide for more details.

\n

Data Revision Policy

\n

Drewry will on occasion publish corrections to price assessments after the\npublication date. These errors may arise from clerical mistakes or miscalculation\nerrors amongst other reasons. Any changes or revisions will take place\nwithin two working days following the closing of the submission window. Drewry\nwill send a notification of any changes to its previous assessments via email to all\nusers with an explanation as to why a correction was implemented.

\n","urlObject":{"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","latest",""],"host":["/"],"query":[],"variable":[{"id":"365c36a3-7001-43aa-a16e-012d4240d83b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"","key":"contract_ticker_symbol"}]}},"response":[{"id":"0851ede6-e1f2-41fb-bfe2-5f2808214ff5","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/latest/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","latest",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": {\n \"id\": 35557930,\n \"contractId\": \"\",\n \"releaseDate\": \"1988-04-26\",\n \"publishedAt\": \"1947-09-19T07:29:39.516Z\",\n \"assessmentWindowClosedAt\": \"2006-04-28T19:11:22.776Z\",\n \"assessmentWindowOpenedAt\": \"1988-10-02T23:00:06.225Z\",\n \"data\": [\n {\n \"revisionNumber\": 53409894,\n \"revisionPublishedAt\": \"1982-02-19T09:05:59.262Z\",\n \"dataPoints\": [\n {\n \"index\": -22320674,\n \"deliveryPeriod\": {\n \"type\": \"months\",\n \"startAt\": \"1977-03-19\",\n \"endAt\": \"1989-10-27\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 97461170.93443361,\n \"unit\": \"usdPerMMBtu\"\n }\n },\n {\n \"index\": -65364083,\n \"deliveryPeriod\": {\n \"type\": \"month\",\n \"startAt\": \"1971-04-06\",\n \"endAt\": \"1954-04-12\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 35836024.50017983,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": -8288613\n }\n },\n {\n \"revisionNumber\": 34470567,\n \"revisionPublishedAt\": \"1968-01-19T05:37:06.519Z\",\n \"dataPoints\": [\n {\n \"index\": 22842210,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1966-10-29\",\n \"endAt\": \"1952-05-30\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": 37205338.22278163,\n \"unit\": \"usdPerMMBtu\"\n }\n },\n {\n \"index\": -68479354,\n \"deliveryPeriod\": {\n \"type\": \"days\",\n \"startAt\": \"1996-09-05\",\n \"endAt\": \"1948-03-25\",\n \"name\": \"\"\n },\n \"derivedPrices\": \"\",\n \"yourAssessedPrice\": {\n \"value\": -23883478.841887966,\n \"unit\": \"usdPerMMBtu\"\n }\n }\n ],\n \"numberOfAssessors\": {\n \"Drewry\": -51927474\n }\n }\n ],\n \"previousPriceRelease\": {\n \"id\": 36367448,\n \"releaseDate\": \"1955-04-21\"\n },\n \"nextPriceRelease\": {\n \"id\": 69544519,\n \"releaseDate\": \"1970-09-30\"\n }\n }\n}"},{"id":"f30a2e39-0d26-4492-937d-b1f91a32c114","name":"Validation Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/price-releases/latest/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol","price-releases","latest",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"9577ce1a-60f2-4878-a1b6-c7b4e1410b29"}],"id":"9a4cf4d2-ae73-4fea-907d-598d58b81b07","_postman_id":"9a4cf4d2-ae73-4fea-907d-598d58b81b07","description":""},{"name":"Read Contract","id":"6812f7dc-272a-46f5-8dc7-022c453de737","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/contracts/:contract_ticker_symbol/","description":"

This endpoint returns the Drewry contracts if, according to your current\nsubscription, you can access it.

\n

Please refer to our Methodology and Specifications Guide for more details.

\n","urlObject":{"path":["v1.0","contracts",":contract_ticker_symbol",""],"host":["/"],"query":[],"variable":[{"id":"42fbc898-f0cb-4aa9-9c67-e6b2e7aa3bf2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"","key":"contract_ticker_symbol"}]}},"response":[{"id":"0bef4b58-6c11-46ca-a31e-6f42289d5828","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": {\n \"id\": \"\",\n \"product\": \"drewry-freight\",\n \"tickerSymbol\": \"\",\n \"fullName\": \"\",\n \"type\": \"forward\",\n \"assessmentFrequency\": [\n {\n \"weekday\": \"wednesday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n },\n {\n \"weekday\": \"thursday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n }\n ],\n \"contractAssumptions\": {\n \"vesselSizeInM3\": -21804874,\n \"duration\": -12658909,\n \"basin\": \"atlantic\",\n \"deliveryPeriod\": \"\",\n \"currency\": \"USD\",\n \"uom\": \"usd/day\",\n \"contractSize\": 28023563\n },\n \"lastUpdatedAt\": \"1941-12-16T08:07:39.348Z\",\n \"latestPriceRelease\": {\n \"id\": -96636725,\n \"releaseDate\": \"1957-03-03\"\n },\n \"nextPriceRelease\": {\n \"id\": -49969928,\n \"releaseDate\": \"1956-02-02\"\n },\n \"firstPriceRelease\": {\n \"id\": 51029719,\n \"releaseDate\": \"1959-06-28\"\n }\n }\n}"},{"id":"9bd34343-090c-42ef-80c5-4478b3590d1f","name":"Validation Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"//v1.0/contracts/:contract_ticker_symbol/","host":["/"],"path":["v1.0","contracts",":contract_ticker_symbol",""],"variable":[{"key":"contract_ticker_symbol"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"6812f7dc-272a-46f5-8dc7-022c453de737"}],"id":"88617f79-91d4-46f5-bc2a-51c680c7fd21","_postman_id":"88617f79-91d4-46f5-bc2a-51c680c7fd21","description":""},{"name":"Read Contracts","id":"bacc34b5-7298-464a-9ab8-a78601c0ad4f","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/contracts/","description":"

This endpoint returns all the Drewry contracts you can access according to your\ncurrent subscription.

\n

Please refer to our Methodology and Specifications Guide for more details.

\n","urlObject":{"path":["v1.0","contracts",""],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"ca280d57-d781-4528-b68d-d6049851462e","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"//v1.0/contracts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": [\n {\n \"id\": \"\",\n \"product\": \"drewry-freight\",\n \"tickerSymbol\": \"\",\n \"fullName\": \"\",\n \"type\": \"front-month\",\n \"assessmentFrequency\": [\n {\n \"weekday\": \"friday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n },\n {\n \"weekday\": \"thursday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n }\n ],\n \"contractAssumptions\": {\n \"vesselSizeInM3\": 13372061,\n \"duration\": -67738012,\n \"basin\": \"pacific\",\n \"deliveryPeriod\": \"\",\n \"currency\": \"USD\",\n \"uom\": \"usd/day\",\n \"contractSize\": 8619324\n },\n \"lastUpdatedAt\": \"2018-07-05T20:02:58.443Z\",\n \"latestPriceRelease\": {\n \"id\": 33269561,\n \"releaseDate\": \"1956-09-05\"\n },\n \"nextPriceRelease\": {\n \"id\": -25379069,\n \"releaseDate\": \"2002-02-10\"\n },\n \"firstPriceRelease\": {\n \"id\": -83335899,\n \"releaseDate\": \"2019-06-12\"\n }\n },\n {\n \"id\": \"\",\n \"product\": \"drewry-freight\",\n \"tickerSymbol\": \"\",\n \"fullName\": \"\",\n \"type\": \"forward\",\n \"assessmentFrequency\": [\n {\n \"weekday\": \"wednesday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n },\n {\n \"weekday\": \"tuesday\",\n \"openingTime\": \"\",\n \"closingTime\": \"\",\n \"timezone\": \"GMT\"\n }\n ],\n \"contractAssumptions\": {\n \"vesselSizeInM3\": -62923820,\n \"duration\": 80324856,\n \"basin\": \"pacific\",\n \"deliveryPeriod\": \"\",\n \"currency\": \"USD\",\n \"uom\": \"usd/day\",\n \"contractSize\": 28692723\n },\n \"lastUpdatedAt\": \"2007-03-14T16:32:12.194Z\",\n \"latestPriceRelease\": {\n \"id\": -11155210,\n \"releaseDate\": \"2019-08-09\"\n },\n \"nextPriceRelease\": {\n \"id\": -74558781,\n \"releaseDate\": \"1986-06-07\"\n },\n \"firstPriceRelease\": {\n \"id\": -34558949,\n \"releaseDate\": \"1956-02-20\"\n }\n }\n ]\n}"}],"_postman_id":"bacc34b5-7298-464a-9ab8-a78601c0ad4f"}],"id":"45b67ef6-62f2-456b-9a1f-2f029142f0bd","_postman_id":"45b67ef6-62f2-456b-9a1f-2f029142f0bd","description":""},{"name":"User","id":"00fbce2d-4056-4693-a85f-032bd02ad6ec","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"//v1.0/me/","description":"

Return information about user

\n","urlObject":{"path":["v1.0","me",""],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"d281120a-ab60-422c-8493-d4019d3f5bef","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"//v1.0/me/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\"\n }\n ],\n \"data\": {\n \"client_id\": \"\",\n \"is_active\": \"\",\n \"organisation_uuid\": \"\",\n \"organisation_type\": \"\",\n \"default_vertical\": \"\",\n \"products\": \"\"\n }\n}"}],"_postman_id":"00fbce2d-4056-4693-a85f-032bd02ad6ec"}],"id":"82cb2047-fd2a-46c2-a601-c6a1751486c2","_postman_id":"82cb2047-fd2a-46c2-a601-c6a1751486c2","description":""},{"name":"Create An Access Token","id":"7db51609-d8ae-49d2-831f-b8e72c5dbaf6","request":{"method":"POST","header":[{"key":"authorization","value":""},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":""},{"key":"scope","value":""},{"key":"client_id","value":""},{"key":"client_secret","value":""},{"key":"refresh_token","value":""}]},"url":"//oauth/token/","description":"

Get a new access_token. Access tokens are the thing that applications use to make\nAPI requests. Access tokens must be kept confidential in storage.

\n

Getting an Access Token

\n
    \n
  • Method: POST
    • \n
  • Body
      \n
    • grant_type (required) = \"client_credentials\".
      • \n
    • scope (optional)
      • \n
    \n
    • \n
  • Headers
      \n
    • Authorization: The \"Basic\" HTTP authentication scheme is defined in RFC 7617,\n which transmits credentials as client_id:client_secret pairs, encoded using\n base64 .
      • \n
    \n
    • \n
\n

A successful response will contain these keys: access_token, token_type,\nexpires_in (duration of time in seconds the access token is granted for) and\nrefresh_token.

\n

Refreshing an Expired Access Token

\n

With the refresh_token, as the access token will expire, you’ll be able to get a\nnew one having to specify the scope variable.

\n
    \n
  • Method: POST
    • \n
  • Body
      \n
    • grant_type (required) = \"refresh_token\".
      • \n
    \n
    • \n
  • Headers
      \n
    • Authorization: The \"Basic\" HTTP authentication scheme is defined in RFC 7617,\n which transmits credentials as client_id/client_secret pairs, encoded using\n base64 (client_id:client_secret).
      • \n
    \n
    • \n
\n

If you do not get back a new refresh token, then it means your existing refresh\ntoken will continue to work when the new access token expires.

\n","urlObject":{"path":["oauth","token",""],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"011b07c6-1d35-4fce-bd45-d5cf289ad771","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"authorization","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":{"content":"","type":"text/plain"},"key":"grant_type","value":""},{"description":{"content":"","type":"text/plain"},"key":"scope","value":""},{"description":{"content":"","type":"text/plain"},"key":"client_id","value":""},{"description":{"content":"","type":"text/plain"},"key":"client_secret","value":""},{"description":{"content":"","type":"text/plain"},"key":"refresh_token","value":""}]},"url":"//oauth/token/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"},{"id":"a36db7da-1b12-4b4d-84fb-14714a8abd65","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"authorization","value":""}],"body":{"mode":"urlencoded","urlencoded":[{"description":{"content":"","type":"text/plain"},"key":"grant_type","value":""},{"description":{"content":"","type":"text/plain"},"key":"scope","value":""},{"description":{"content":"","type":"text/plain"},"key":"client_id","value":""},{"description":{"content":"","type":"text/plain"},"key":"client_secret","value":""},{"description":{"content":"","type":"text/plain"},"key":"refresh_token","value":""}]},"url":"//oauth/token/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_in\": -43207354,\n \"refresh_token\": \"\"\n}"}],"_postman_id":"7db51609-d8ae-49d2-831f-b8e72c5dbaf6"},{"name":"Health","id":"6c5a4505-481b-4207-ae5f-2036da564a39","request":{"method":"GET","header":[],"url":"//health/","description":"

Use this to check if the API is alive. No authentication needed.

\n","urlObject":{"path":["health",""],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"2d76f70b-5589-4175-9b0e-109455d86916","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"//health/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"serverDateTime\": \"1998-01-25T19:21:36.067Z\"\n}"}],"_postman_id":"6c5a4505-481b-4207-ae5f-2036da564a39"}],"variable":[{"id":"baseUrl","key":"baseUrl","value":"/","type":"string"}]}