# Freightos Terminal Documentation

> Documentation for Freightos Terminal

Append .md to any documentation page URL to get its markdown version.

## API Reference
- [FAX Airline Specific Data](https://apidocs.freightos.com/reference/get_fax-airline-specific.md): Fetches airline specific data for a specific airline on a specific tradelane.
- [Airline Scope](https://apidocs.freightos.com/reference/get_fax-airline-specific-airline-scope.md): Fetches and returns FAX Airlines Scope which is the list of airlines
- [FAX Big Regions](https://apidocs.freightos.com/reference/get_fax-big-regions.md): Retrieves FAX Big Regions Rates. Weekly/Daily and default from_date depend on the permissions level. Weekly Returns Sundays data only, and Daily Returns Everyday data
- [FAX Global](https://apidocs.freightos.com/reference/get_fax-global.md): Returns FAX Global Rates with corresponding dates. Weekly Returns Sundays data only, and Daily Returns Everyday data
- [FAX Scope](https://apidocs.freightos.com/reference/get_fax-scope.md): Returns FAX Scope Values (Tradelanes & Weight Breaks)
- [FBX Data](https://apidocs.freightos.com/reference/get_fbx-data.md): Retreives weekly and/or daily FBX rates.
- [FBX Tickers](https://apidocs.freightos.com/reference/get_fbx-tickers.md): Returns current values of all FBX tickers plus the change percentage (daily or weekly frequency), default is determined by permissions level.
- [Market Updates / Key Events](https://apidocs.freightos.com/reference/get_market-updates.md): Returns Market Update Events. This API takes tickers for FBX, regions for FAX, or origins and destinations for custom tradelanes. The hierarchy is as follows:  1) Tickers  2) Regions  3) Origins & Destinations  If all are specified, the tickers will have priority, then regions and finally origins and destinations. If none are specified, an error will be returned. Note that permissions for this API are separate depending on the product ["FBX", "FAX", "MIR (custom tradelanes)"]. If you send tickers then it means you're making the request for FBX, regions means it's a request for FAX and origins+destinations are for custom tradelanes.
- [Transit Time Stats](https://apidocs.freightos.com/reference/get_time-stats.md): Returns transit-time data in hours or days for a set of port-port routes or a specific route.  How to use? 1. If user do did not provide origin, destination, mode and load we will fetch user routes from terminal and provide the transit time stats. 2. If user provides origin, destination, mode and load transit time stats will be returned for this route only.  What is confidence level? Confidence level represents the amount of data points used to calculate the percentiles for a specific route   For FCL Routes {     "low": "1 or 2 data points",     "medium": "3 or 4 data points",     "high": "5 to 9 data points",     "very high": "+10 data points" }  For Air Routes {     "low": "1 to 9 data points",     "medium": "10 to 49 data points",     "high": "50 to 199 data points",     "very high": "+200 data points" }
- [Get price statistics (GET)](https://apidocs.freightos.com/reference/getpricestats-1.md): Retrieve price statistics using query parameters. You can query a single route by providing all route parameters, or query your subscription routes by omitting route parameters.  **Rate Limit**: 10 requests per minute **Typical Response Time**: 2-16 seconds  **Route Quota**: Each subscription has a limit on unique routes you can query. Routes are uniquely identified by origin, destination, mode, and load tag. Only routes that return actual data (with coverage) count toward your quota. Once a route is stored with coverage, you can query it repeatedly without using quota. If you exceed your quota, you'll receive an error message indicating how many routes you're allowed and how many you requested.
- [Get price statistics (POST)](https://apidocs.freightos.com/reference/postpricestats-1.md): Retrieve price statistics with routes specified in the request body. Use this method to query multiple routes in a single request, or to query your subscription routes by omitting the routes array.  **Rate Limit**: 10 requests per minute **Typical Response Time**: 2-16 seconds  **Route Quota**: Each subscription has a limit on unique routes you can query. Routes are uniquely identified by origin, destination, mode, and load tag. Only routes that return actual data (with coverage) count toward your quota. Once a route is stored with coverage, you can query it repeatedly without using quota. If you exceed your quota, you'll receive an error message indicating how many routes you're allowed and how many you requested.
- [Get price forecast (GET)](https://apidocs.freightos.com/reference/getpriceforecast.md): Retrieve a weekly price forecast using query parameters. You can forecast a single route by providing all route parameters, or forecast your subscription routes by omitting route parameters.  **Rate Limit**: 30 requests per minute **Typical Response Time**: 5-30 seconds  **Forecast Horizon**: The number of forecasted weeks is capped by your subscription's horizon (default 3 months ≈ 13 weekly rows). Requesting more weeks than allowed returns the maximum your subscription permits.  **Route Quota**: Forecast requests use the same unique-route quota as the Price Stats API.