Forecast freight rates with scenario analysis | Freight Rate Intelligence API

curl -X POST https://freightrateintelligence.com/v1/forecast \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "origin": "Dallas, TX",
  "destination": "Chicago, IL"
}'

{
  "ok": true,
  "data": {
    "lane": {
      "origin": "string",
      "destination": "string",
      "distance_miles": 1.1,
      "equipment": "string",
      "equipment_display": "string",
      "mode": "string"
    },
    "current_rate": 2.332,
    "forecasts": {},
    "drivers": [
      {
        "factor": "string",
        "weight": 1.1,
        "direction": "UP",
        "evidence": "string"
      }
    ],
    "methodology": {
      "approach": "string",
      "data_inputs": [
        "string"
      ],
      "model_limitations": [
        "string"
      ],
      "historical_accuracy": "string"
    },
    "confidence": {
      "level": "HIGH",
      "score": 1.1,
      "label": "string",
      "factors": [
        "string"
      ]
    },
    "model_type": "COST_BASIS_FORECAST",
    "model_disclaimer": "string",
    "factor_versions": [
      {
        "source": "EIA",
        "series_id": "PET.EMD_EPD2DXL0_PTE_R30_DPG.W",
        "version": "latest",
        "fetched_at": "2024-01-15T09:30:00Z"
      }
    ],
    "horizon_warning": "string"
  },
  "receipt_id": "rcpt_01abc...",
  "auth_obj_id": "auth_01xyz..."
}

Projects freight rates forward with base, bullish, and bearish scenarios. Returns time series with confidence intervals, key driver analysis, and methodology transparency. Requires Professional tier.

Authentication

AuthorizationBearer

Your Freight Rate Intelligence API key. Get one at freightrateintelligence.com/dashboard/settings

Request

This endpoint expects an object.

originstringRequired

destinationstringRequired

modeenumOptional

Allowed values:

equipmentenumOptionalDefaults to DRY_VAN

Equipment type for the forecast

horizon_daysintegerOptional7-90Defaults to 30

Forecast horizon in days (7-90). Confidence intervals widen beyond 30 days.

granularityenumOptionalDefaults to DAILY

DAILY returns one data point per day. WEEKLY returns one per week (Mon-Sun avg).

Allowed values:

scenarioslist of enumsOptional

Allowed values:

include_methodologybooleanOptionalDefaults to true

Include methodology section in response. Defaults to true.

Response

Rate forecast with receipt

okboolean

dataobject

Skill-specific response data

receipt_idstring

auth_obj_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error