API reference
Every endpoint of the FX-Port API: parameters, request and response objects, examples in nine languages and the errors each can return.
The FX-Port API is a REST API with predictable URLs, JSON request and response bodies, and standard HTTP status codes. Use it from your server to search, price and book flights and hotels, sell eSIMs, and read your balances and bookings. This reference is generated from the OpenAPI document, so it always matches what the API accepts and returns. New here? Start with the Quickstart.
Base URL
https://api.fx-port.com/api/v1Live and sandbox share the base URL: the key you send decides which environment a request belongs to. Keys start with fxp_test_ for the sandbox and fxp_live_ for live. Every path in this reference is relative to the base URL.
Authentication
Send your key as a bearer token:
Authorization: Bearer fxp_test_YOUR_KEYCreate keys in the dashboard. A Read key can search, price and read; a Read+Write key can also book, pay and cancel. Each endpoint page says which one it needs. See Authentication and Security.
Requests and responses
- Bodies are JSON (
Content-Type: application/), except the ACD passport upload, which isjson multipart/.form-data - Request fields use
snake_case. Older endpoints also accept their legacycamelCasespellings, and the reference marks them as deprecated and names the spelling to use: see Conventions and naming and the list of legacy names. Responses keep their older keys and addsnake_casetwins;?naming=snakereturnssnake_caseonly. - Every JSON response starts with an
environmentfield (sandboxorlive), also sent in theX-Environmentheader, and carries arequest_id(also theX-Request-Idheader) to quote to support. - Prices come back in the currency of the agency that owns the key. You never send a currency.
- The travel dates in the examples are fixed dates: send a date 30 to 60 days ahead, because a date in the past is refused with
date_in_past. - A failed call returns the same error body everywhere (
errors[].code,errors[].type,errors[].message): see Errors. - Keys are limited per minute: see Rate limits. Flight searches can be streamed: see Streaming.
Endpoints
| Method | Path | Permission | Description |
|---|---|---|---|
| GET | /api/v1/flights/airports | None | Search airports |
| GET | /api/v1/flights/top-airports | None | Get the most searched airports |
| POST | /api/v1/get_flights | Read | Search flights |
| POST | /api/v1/flights/flexible_search | Read | Search flexible dates |
| POST | /api/v1/flights/price_flight | Read | Price a flight offer |
| POST | /api/v1/flights/book_flight | Read+Write | Book a flight offer |
| POST | /api/v1/flights/get_booking | Read | Get a flight booking |
| POST | /api/v1/flights/get_ticket | Read | Get the ticket PDF of a booking |
| POST | /api/v1/flights/get_ticket_number | Read | Get the e-ticket number of a booking |
| POST | /api/v1/flights/get_order_quote | Read | Get the current quote of an order |
| POST | /api/v1/flights/pay_order | Read+Write | Pay a held order and issue the tickets |
| POST | /api/v1/flights/cancel_order | Read+Write | Cancel a held reservation |
| POST | /api/v1/flights/cancel_quote | Read | Quote the refund of an issued order |
| POST | /api/v1/flights/confirm_cancel | Read+Write | Confirm the cancellation of an order |
| POST | /api/v1/flights/get_acd_documents | Read | Get the ACD document state of a booking |
| POST | /api/v1/flights/upload_acd_documents | Read+Write | Upload ACD passport documents |
| GET | /api/v1/hotels/locations/search | Read | Search destinations and get coordinates |
| GET | /api/v1/hotels/name-search | Read | Find a hotel by name |
| POST | /api/v1/hotels/search-by-name | Read | Find a hotel by name (JSON body) |
| POST | /api/v1/hotels/search_advanced | Read | Geo search: hotels around a point |
| POST | /api/v1/hotels/search | Read | Read the content of many hotels by id |
| POST | /api/v1/hotels/details | Read | Read the raw hotel documents by id |
| POST | /api/v1/hotels/get_hotel_info | Read | Read one hotel for the hotel page |
| POST | /api/v1/hotels/get_rates | Read | Get the rooms and rates of one hotel |
| POST | /api/v1/hotels/pre_book | Read+Write | Lock a rate before booking |
| POST | /api/v1/hotels/book_hotel | Read+Write | Book a locked rate |
| POST | /api/v1/hotels/cancel_hotel | Read+Write | Cancel a confirmed hotel booking |
| GET | /api/v1/hotels/get_voucher | Read | Get the voucher PDF links of a booking |
| GET | /api/v1/esims/packages | Read | List eSIM packages |
| GET | /api/v1/esims/compatible-devices | Read | List eSIM compatible devices |
| POST | /api/v1/esims/orders | Read+Write | Create an eSIM order |
| GET | /api/v1/esims/topup-packages/{iccid} | Read | List topup packages of an eSIM |
| POST | /api/v1/esims/topups | Read+Write | Top up an eSIM |
| GET | /api/v1/esims/usage/{iccid} | Read | Get the usage of an eSIM |
| GET | /api/v1/esims/usage/bulk | Read | Get the usage of several eSIMs |
| GET | /api/v1/esims/bookings | Read | List eSIM bookings |
| GET | /api/v1/esims/bookings/{iccid}/topup-history | Read | List the topups of an eSIM |
| GET | /api/v1/esims/bookings/{booking_id}/verify | Read | Check that an eSIM booking is yours |
| GET | /api/v1/esims/bookings/{booking_id}/setup-instructions | Read | Get the setup data of a booking |
| GET | /api/v1/esims/instructions/{iccid} | Read | Get eSIM installation instructions |
| GET | /api/v1/balances | Read | List balances |
| GET | /api/v1/balances/{balance_id}/history | Read | Get the history of a balance |
| GET | /api/v1/history | Read | List booking history |
| GET | /api/v1/bookings/{booking_id} | Read | Get a booking |
| GET | /api/v1/suppliers | Read | List suppliers |
For tools and AI
The whole reference is one file: / (OpenAPI 3.1, with an operationId, examples and error codes for every endpoint). Every page of this site is also available as Markdown by adding .md to its address, and / indexes them. See Use these docs with AI.