/searates/freight_index/series

POST /api/searates/freight_index/series

Price: 1 credit

Get a SeaRates Freight Index daily series for a shipping type and transport unit, or for a trending index id, over a chosen date range.

How to use it

Returns one index with a value per day in USD and summary statistics over the window. Without dates the source picks a recent 30-day window. Use shipping_types to find unit ids, and trending for lane-level index ids between regions. bulk_size_id narrows a BULK unit to one of its bulk_sizes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shipping_type string nullable — Shipping type of the index; required unless index_id is given (one of: "FCL", "LCL", "BULK", "RoRo", "FWL", "LWL", "RAIL_FCL", "RAIL_FTL", "FTL", "LAND_FCL", "LTL", "AIR", "ULD"; examples: "FCL")
• transport_unit_type_id integer nullable — Transport unit of the shipping type, an id from /searates/freight_index/shipping_types (examples: 1; min: 1)
• bulk_size_id integer nullable — Bulk size of the transport unit, an id from the bulk_sizes of a BULK unit in /searates/freight_index/shipping_types; only with transport_unit_type_id (examples: 4; min: 1)
• index_id string nullable — Index id returned by /searates/freight_index/trending; use instead of shipping_type (examples: "FI|2|RE-21|RE-18|3|||D|26-08-13|26-09-12")
• date_from string nullable — First day of the series, inclusive; give together with date_to (format: date; examples: "2026-06-01")
• date_to string nullable — Last day of the series, inclusive, not after today (format: date; examples: "2026-09-01")

Response

• @type string (default: "SearatesFreightIndex")
• id string required
• description string nullable
• shipping_type_id integer nullable
• transport_unit_type_id integer nullable
• bulk_size_id integer nullable
• origin object nullable
  • @type string (default: "SearatesRegion")
  • id string required
  • place_type string nullable
  • name string nullable
• destination object nullable
  • @type string (default: "SearatesRegion")
  • id string required
  • place_type string nullable
  • name string nullable
• date_from string nullable
• date_to string nullable
• is_valid boolean nullable
• statistics object nullable
  • @type string (default: "SearatesIndexStatistics")
  • first number nullable
  • last number nullable
  • average number nullable
  • median number nullable
  • min number nullable
  • max number nullable
  • change_percent number nullable
• points array (default: [])
  • @type string (default: "SearatesIndexPoint")
  • date string required
  • value number required

Errors

• 422 — transport_unit_type_id is not a unit of this shipping_type, or bulk_size_id is not a bulk size of this transport_unit_type_id 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 — SeaRates publishes no freight index for these filters 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.