Availability

Get all availability for a publisher, hotel, room type and date range.

At the moment, you are not able to obtain ARI data from the following Publishers: Little Hotelier and SiteMinder Channel Manager.

get

Fetch the availability for a given publisher, hotel and room type

Authorizations

BearerAuthorization

AuthorizationstringRequired

This API uses JWT for Authentication/Authorisation (please see jwt.io for further details).

The token can be obtained via the SMX Subscriber Admin portal.

The request header must be in the following format (where 'token' is the encoded JWT string):

Authorization: Bearer token

The decoded JWT must include the following claims for it to be accepted by the API:

• iat - Token issued time
• jti - ID of the token
• aud - Audience of the token. This API expects the value to be 'subscriberx/api'.
• sub - Subject of the token. This API expects the value to be the code of the subscriber.

Example of JWT claims in a decoded token for the subscriber with code 'subscriberCode':

{
  'iat': 1576812219,
  'jti': 'e07f7327-490c-4dd7-8d63-c1bdd1f93001',
  'aud': 'subscriberx/api',
  'sub': 'subscriberCode'
}

Path parameters

publisherCodestring · min: 1 · max: 50Required

Publisher code

hotelCodestring · min: 1 · max: 255Required

Hotel code

roomTypeCodestring · min: 1 · max: 255Required

Room type code

Query parameters

startDatestring · dateRequired

Start date to query for availability

rangenumber · min: 1 · max: 30Optional

The number of days to query for

Default: 1

Responses

200

OK

application/json

400

One or more inputs in the request are invalid

application/json

401

Not Authorised

application/json

403

Do not have access to the specified resource

application/json

404

Resource does not exist

application/json

405

Operation not supported by the requested resources

application/json

429

Exceeded API quota for the time period

application/json

500

Internal Server Error

application/json

get

/publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability

HTTPcURLJavaScriptPython

GET /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability?startDate=2026-05-15 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "bookingLimit": 1,
    "date": "2026-05-15",
    "ratePlanCode": "text",
    "roomTypeCode": "text",
    "minLOS": 1,
    "maxLOS": 1,
    "restriction": "Master",
    "status": "Open",
    "lastModifiedAt": "2026-05-15T08:04:31.921Z"
  }
]

get

Fetch the availability for a given publisher, hotel and rate plan

Authorizations

BearerAuthorization

AuthorizationstringRequired

This API uses JWT for Authentication/Authorisation (please see jwt.io for further details).

The token can be obtained via the SMX Subscriber Admin portal.

The request header must be in the following format (where 'token' is the encoded JWT string):

Authorization: Bearer token

The decoded JWT must include the following claims for it to be accepted by the API:

• iat - Token issued time
• jti - ID of the token
• aud - Audience of the token. This API expects the value to be 'subscriberx/api'.
• sub - Subject of the token. This API expects the value to be the code of the subscriber.

Example of JWT claims in a decoded token for the subscriber with code 'subscriberCode':

{
  'iat': 1576812219,
  'jti': 'e07f7327-490c-4dd7-8d63-c1bdd1f93001',
  'aud': 'subscriberx/api',
  'sub': 'subscriberCode'
}

Path parameters

publisherCodestring · min: 1 · max: 50Required

Publisher code

hotelCodestring · min: 1 · max: 255Required

Hotel code

ratePlanCodestring · min: 1 · max: 255Required

Rate plan code

Query parameters

startDatestring · dateRequired

Start date to query for availability

rangenumber · min: 1 · max: 30Optional

The number of days to query for

Default: 1

Responses

200

OK

application/json

400

One or more inputs in the request are invalid

application/json

401

Not Authorised

application/json

403

Do not have access to the specified resource

application/json

404

Resource does not exist

application/json

405

Operation not supported by the requested resources

application/json

429

Exceeded API quota for the time period

application/json

500

Internal Server Error

application/json

get

/publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability

HTTPcURLJavaScriptPython

GET /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability?startDate=2026-05-15 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "bookingLimit": 1,
    "date": "2026-05-15",
    "ratePlanCode": "text",
    "roomTypeCode": "text",
    "minLOS": 1,
    "maxLOS": 1,
    "restriction": "Master",
    "status": "Open",
    "lastModifiedAt": "2026-05-15T08:04:31.921Z"
  }
]

Still have questions?

Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit Integration Support.