{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"985f7793-96da-4e8a-bcb2-b0ee9806bf8b","name":"Drewry Data API Documentation","description":"\n<h2>General Information</h2>\n<p>\n    You can find general information here:\n    <a href=\"https://github.com/freight-trust/container-index\">\n        https://github.com/freight-trust/developers/\n    </a>\n</p>\n\n<h2>Maintenance Window</h2>\n<p>\n    No maintenance scheduled.\n</p>\n\n<h2>URLs</h2>\n\nAPI Base URL is <b>https://api.containerfreightindex.com</b>.\n\nFull URL example: https://api.containerfreightindex.com/v1.0/contracts/\n\n<h2>Versioning</h2>\n<p>\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</p>\n\n<h2>HTTP Statuses</h2>\n\nThis API uses conventional HTTP response codes to indicate the success or failure of an API request.\n\nIn 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\nReturn 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\nIf 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\nHere is a list of supported codes:\n\n<ul>\n    <li>200: Successful Operation</li>\n    <li>201: Entity Created</li>\n    <li>400: Bad Request Exception / Limit Exceeded Exception</li>\n    <li>401: Unauthorized</li>\n    <li>403: Forbidden</li>\n    <li>422: Validation Error</li>\n    <li>429: Too Many Requests Exception</li>\n    <li>500: Internal Server Error</li>\n    <li>503: Maintenance Mode</li>\n</ul>\n\n<h2>Responses and Data Format</h2>\n\nWhen 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\nIn 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\n<h2>Authentication</h2>\n\nIn order to interact with the DrewryAPI, your application must authenticate.\n\nThe Drewry API handles this through OAuth, an open standard for\nauthorization, with a two-legged Oauth 2 approach (using client credentials).\n\nAn access token is needed to authenticate your application for every endpoint.\n\n<h3>How to get an Access Token with OAuth 2?</h3>\n\nUse the <b>https://api.freighttrust.com/oauth/token/</b> endpoint with your\ncredentials to receive a token. The necessary <b>client_id</b> and\n<b>client_secret</b> credentials are provided by Drewry. Please contact us at\nadmin@freighttrust.com to request them.\n\nBecause of this, it is <b>absolutely</b> essential that you keep your <b>client_id</b>\nand <b>client_secret</b> credentials secure.\n\nA token is valid for 30 minutes. After that, you can either refresh it or create a new\none.\n\n<h3>How to Authenticate with your Access Token?</h3>\n\nIn order to make an authenticated request, include a bearer-type Authorization header\ncontaining your OAuth token. <b>All requests must be made over HTTPS.</b>\n\nFor example: `Authorization: Bearer YOUR-TOKEN`\n\n<h2>Usage Plans</h2>\n<p>\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</p>\n\n<ul>\n    <li>Throttling (requests per second): 50 req/sec</li>\n    <li>Burst (bucket size): 200</li>\n    <li>Quota (requests per day): 1000 req/day</li>\n</ul>\n\n<h2>Code Samples:</h2>\n\n<a href=\"https://github.com/drewry-uk/api-code\">\n  \n\n<a href=\"https://github.com/freight-trust/container-freight\">\n   View samples on GitHub\n</a>\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9323065","team":1093690,"collectionId":"985f7793-96da-4e8a-bcb2-b0ee9806bf8b","publishedId":"T17M7R9P","public":true,"publicUrl":"https://drewry.containerfreightindex.com","privateUrl":"https://go.postman.co/documentation/9323065-985f7793-96da-4e8a-bcb2-b0ee9806bf8b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2020-07-10T18:39:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/77330f5af12b6e69d75d5b91da887c015ee3aa47cd42101853cde295cf42adb8","favicon":"https://containerfreightindex.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/T17M7R9P"}