/freightos/indexes/series

POST /api/freightos/indexes/series

Price: 10 credits

Get the recent weekly values of a Freightos Baltic Index (ocean container) or Freightos Air Index series, global or for one lane.

How to use it

Returns one series with its dated weekly values, oldest first, for the weeks Freightos shows publicly. FBX values are container prices and FAX values are air cargo prices per kilogram. Pick a lane code to compare a trade lane with the global index.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• index_id string required — Index to fetch: FBX for the global ocean container index, FBX01-FBX26 for an ocean lane, FAX for the global air index, or a FAX lane (one of: "FBX", "FBX01", "FBX02", "FBX03", "FBX04", "FBX11", "FBX12", "FBX13", "FBX14", "FBX21", "FBX22", "FBX24", "FBX26", "FAX", "FAX_EUROPE_TO_EUROPE", "FAX_EUROPE_TO_GREATER_CHINA_ASIA", "FAX_EUROPE_TO_NORTH_AMERICA", "FAX_GREATER_CHINA_ASIA_TO_EUROPE", "FAX_GREATER_CHINA_ASIA_TO_MIDDLE_EAST", "FAX_GREATER_CHINA_ASIA_TO_NORTH_AMERICA", "FAX_MIDDLE_EAST_TO_EUROPE", "FAX_MIDDLE_EAST_TO_MIDDLE_EAST", "FAX_MIDDLE_EAST_TO_NORTH_AMERICA", "FAX_NORTH_AMERICA_TO_EUROPE", "FAX_NORTH_AMERICA_TO_GREATER_CHINA_ASIA", "FAX_NORTH_AMERICA_TO_MIDDLE_EAST"; examples: "FBX", "FBX01", "FAX", "FAX_EUROPE_TO_NORTH_AMERICA")

Response

• @type string (default: "FreightosIndexSeries")
• id string required
• name string required
• url string required
• points array (default: [])
  • @type string (default: "FreightosIndexPoint")
  • date string required
  • value number required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Freightos does not publish this index page Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.