Getting Started

Introduction

The PointsYeah API allows you to query award flight and hotel availability across 40+ airline and hotel loyalty programs. The API returns real-time redemption pricing, seat availability, and transfer partner information.

Base URL

All API requests should be made to the following base URL:

https://ai-api.pointsyeah.com

Authentication

All API requests require an API key passed via the X-API-Key header. Enter your key in the Try It panel on any endpoint page to test requests.

X-API-Key: YOUR_API_KEY

The feature is available for the premium tier, with a max of 1000 calls per day. You will see a 'Create API Key' button under your account profile.

Content Types

All responses are in JSON format. For GET requests, parameters are sent as query strings. For POST requests, send a JSON body with the Content-Type: application/json header.

Rate Limits

Premium members can make a maximum of 1000 calls per day. Please be respectful and avoid excessive polling. Implement caching where appropriate.

Errors

The API uses standard HTTP status codes. A 200 response indicates success. 500 responses indicate an internal server error, usually caused by malformed request bodies. Response bodies for errors contain a message field with a description of the error.

CORS

The API supports cross-origin requests (CORS). You can make requests directly from the browser without a proxy.