Rate Capture API

Start Rate Capture runs from your own code and read every room and rate they capture. Rate Capture is part of Beacon Pro, and runs are paid for with your company's Beacon Pro credits.

In short

The Rate Capture API lets your own code collect the room rates that hotels show online. You send a list of properties. You get back every room and price for the next 365 days. If you only want rates in a spreadsheet, the recipes need no code. The rest of this page is for developers.

What it does

You send a list of properties, a currency and a stay length. Rate Capture checks every property for every check-in date over the next 365 days and records every room and rate a guest is shown online, including sold-out dates. You then download the rows, or ask for one price per property and day.

Two ways in

One Beacon Pro key works with both.

API	Base URL	Use it for
Rate Capture API	`https://api.pro.getbeacon.cloud/v1`	Starting runs, reading their rates and checking your credits. Can read and write.
Lighthouse-compatible API	`https://api.pro.getbeacon.cloud/lighthouse/v3`	Reading Rate Capture runs with a client written for Lighthouse. Read only. See switching from Lighthouse.

How an integration works

Start a run with POST /v1/runs: a name, your own reference, a list of property URLs, a currency and a stay length. It checks every check-in date for the next 365 days and costs one credit per property.
Wait for it to finish by checking GET /v1/runs/{id} no more than once a minute. A run usually takes minutes.
Read the rates with GET /v1/runs/{id}/results for every room and rate, or GET /v1/runs/{id}/rates for one price per property and day.

The quick start walks through these steps with curl, Python and JavaScript.

Before you start

You need a Beacon Pro account. Every new account gets 6 free credits.
A company owner or admin creates API keys in the app, under Company, then API. See API keys.
Every request is sent over HTTPS with the key in an Authorization: Bearer header, or in X-Oi-Authorization, the header Lighthouse clients already send. See making requests.

Where to go next

New to the API: the quick start, then how Rate Capture works.
Choosing endpoints: what each endpoint is for.
Mapping columns: the field dictionary, with sample files.
A ready-made job: recipes for Excel and Power BI, a data warehouse, or one reference per client.
Every parameter and field: the API reference.

OpenAPI files

Both APIs are described in OpenAPI 3 files. Developer tools can turn these into client code or Postman collections. The reference pages are built from the same files.

The Rate Capture file is also served by the API itself at https://api.pro.getbeacon.cloud/v1/openapi.json, with no key needed. It is the same file as rate-capture.json.