Suppliers

GET /api/v1/suppliers

Permission: Read. Rate limit: the default group, 6,000 requests per minute per key.

Returns the suppliers that are enabled for your key, grouped by product: flights, hotels and eSIMs. This endpoint spans every product, not only flights. A product with no enabled supplier is left out, and so are disabled suppliers.

Request

curl --request GET \
  --url https://api.fx-port.com/api/v1/suppliers \
  --header 'Authorization: Bearer fxp_test_YOUR_KEY'

const response = await fetch("https://api.fx-port.com/api/v1/suppliers", {
  headers: { Authorization: "Bearer fxp_test_YOUR_KEY" },
});
const { products } = await response.json();
const flights = products.find((entry) => entry.product === "flights")?.suppliers ?? [];
const canHold = flights.filter((supplier) => supplier.capabilities?.hold);

import requests

response = requests.get(
    "https://api.fx-port.com/api/v1/suppliers",
    headers={"Authorization": "Bearer fxp_test_YOUR_KEY"},
    timeout=30,
)
products = response.json()["products"]

Response example

A sandbox answer. description is free text written by FX-Port: it is shortened to ... here and can change.

{
  "environment": "sandbox",
  "success": true,
  "products": [
    {
      "product": "flights",
      "suppliers": [
        {
          "id": "amadeus_aqc_dz_1",
          "name": "Amadeus Algeria",
          "technology": "amadeus_aqc",
          "routes": ["DZ"],
          "description": "...",
          "capabilities": { "hold": true, "void": true, "flexible_dates": true, "ancillaries": false },
          "voidDeadline": "2026-11-01T23:00:00Z",
          "void_deadline": "2026-11-01T23:00:00Z"
        },
        {
          "id": "duffel_1",
          "name": "Duffel",
          "technology": "duffel",
          "routes": ["*"],
          "description": "...",
          "capabilities": { "hold": false, "void": false, "flexible_dates": false, "ancillaries": true },
          "voidDeadline": "2026-11-02T00:00:00Z",
          "void_deadline": "2026-11-02T00:00:00Z"
        }
      ]
    },
    {
      "product": "hotels",
      "suppliers": [
        { "id": "worldota_1", "name": "RateHawk", "technology": "worldota", "description": "..." }
      ]
    },
    {
      "product": "esims",
      "suppliers": [
        { "id": "airalo_1", "name": "Airalo", "technology": "airalo", "description": "..." }
      ]
    }
  ],
  "meta": { "environment": "sandbox", "permissionRequired": "read", "permission_required": "read" }
}

What the list contains

These are the suppliers of the sandbox today. The eSIM block is listed when the eSIM supplier is configured. FX-Port can enable more suppliers (and disable some): the list tells what your key can use right now.

Field reference

Every supplier

Flight suppliers only

Hotel and eSIM suppliers have only id, name, technology and description.

meta

Sandbox and live

The endpoint, the shape and the way to read it are the same in both environments, and the list is not filtered by the environment of your key: meta.environment only tells which environment answered. What differs is what a supplier's own test system can do: see Sandbox.

Supplier ids in your bookings

The id in this list is the one to send to the API. The bookings of your account carry the id stored on the booking (supplierId in the booking history), and that id is not always the same one:

Do not match bookings with this list on the id alone: use providerName or keep your own mapping.

The voidDeadline field

Errors