Drewry

Drewry Benchmark Freight Index API

General Information You can find general information here: https://developers.freighttrust.com/ Maintenance Window No maintenance scheduled. URLs API Base URL…

Logistics & shipping#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

General Information

You can find general information here:

https://developers.freighttrust.com/

Maintenance Window

No maintenance scheduled.

URLs

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

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

Versioning

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

HTTP Statuses

Freight Trust & Clearing uses conventional HTTP response codes to indicate the success or
failure of an API request.

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.

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.

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.

Here is a list of supported codes:

200: Successful Operation
201: Entity Created
400: Bad Request Exception / Limit Exceeded Exception
401: Unauthorized
403: Forbidden
422: Validation Error
429: Too Many Requests Exception
500: Internal Server Error
503: Maintenance Mode

Responses and Data Format

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.

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

Authentication

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

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

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

How to get an Access Token with OAuth 2?

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

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

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

How to Authenticate with your Access Token?

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

For example: Authorization: Bearer YOUR-TOKEN

Usage Plans

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

Throttling (requests per second): 50 req/sec
Burst (bucket size): 200
Quota (requests per day): 1000 req/day

Code Samples:

View samples on GitHub

Endpoints 8

Authentication

  • POSTCreate An Access Token/oauth/token/Get a new access_token. Access tokens are the thing that applications use to make API requests. Access tokens must be kept confidential in storage. Getting an…
  • GETMe/v1.0/me/Return information about user

Utilities

  • GETHealth/health/Use this to check if the API is alive. No authentication needed.

Contracts & Price Releases

  • GETRead Contracts/v1.0/contracts/This endpoint returns all the Drewry contracts you can access according to your current subscription. Please refer to our Methodology and Specifications Guide…
  • GETRead Contract/v1.0/contracts/:contract_ticker_symbol/This endpoint returns the Drewry contracts if, according to your current subscription, you can access it. Please refer to our Methodology and Specifications…
  • GETRead Price Releases/v1.0/contracts/:contract_ticker_symbol/price-releases/For a specific contract, this endpoint returns all the Price Releases you can access according to your current subscription. Drewry releases (publishes)…
  • GETRead First Price Release/v1.0/contracts/:contract_ticker_symbol/price-releases/first/For a specific contract, this endpoint returns the first Price Releases if, according to your current subscription, you can access it. Drewry releases…
  • GETRead Latest Price Release/v1.0/contracts/:contract_ticker_symbol/price-releases/latest/For a specific contract, this endpoint returns the latest Price Releases if, according to your current subscription, you can access it. Drewry releases…

API details

Authentication
OAuth 2.0 (client credentials flow) with 1 scope
Operations
8 operations on 8 pathsGET 7POST 1
Main resources
Contracts & Price Releases 5Authentication 2Utilities 1
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0.0

How to test the Drewry Benchmark Freight Index API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Drewry Benchmark Freight Index API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create An Access Token” (POST /oauth/token/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Drewry Benchmark Freight Index API?

General Information You can find general information here: https://developers.freighttrust.com/ Maintenance Window No maintenance scheduled. URLs API Base URL… It is listed under Logistics & shipping and has 8 endpoints.

Who publishes the Drewry Benchmark Freight Index API?

It is listed from Drewry's public API description (an OpenAPI document), not published by Drewry on Swastik Codes. Anyone who controls drewry.co.uk can claim the profile by adding a DNS TXT record.

How do I authenticate with the Drewry Benchmark Freight Index API?

With OAuth 2.0 (client credentials flow) with 1 scope.

How many endpoints does the Drewry Benchmark Freight Index API have?

8 operations on 8 paths (7 GET, 1 POST). The largest groups are Contracts & Price Releases, Authentication, Utilities.

Is forking the Drewry Benchmark Freight Index API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.