Beacon API docs
Guides, references and OpenAPI files for Beacon's APIs. Each API has its own section. The basics, such as keys, errors and limits, are shared, so you read them once.
In short
Beacon's Rate Capture API collects the room rates that hotels show online and gives them to you as data. You can load them into Excel, Power BI or a data warehouse. You don't need to write code to see rates in Excel. If you use Lighthouse today, the Lighthouse section shows how to switch.
APIs
Rate Capture APICapture every room and rate shown online for a list of properties, across the next 365 check-in dates, and load them into your own tools. Part
of Beacon Pro.
Lighthouse-compatible APIPart of Rate Capture. Three read endpoints that answer like Lighthouse's v3 rates API, so code written for Lighthouse can read Beacon
runs.
What do you want to do?
- Load rates into your data warehouse. Start with the quick start, then rates into your data warehouse, on whatever schedule suits you.
- See rates in Excel or Power BI. Follow rates in Excel or Power BI. No code needed.
- Run captures for clients or markets. See one reference per client or market.
- Move an integration from Lighthouse. Read switching from Lighthouse.
- Get more than Lighthouse gives. Read moving from Lighthouse to /v1.
- Map Beacon's columns to your own. Use the field dictionary and its sample files.
- Talk to us about an integration. Email support@getbeacon.cloud and tell us what you want to build.
API basics
These apply to all of Beacon's APIs, with any differences noted on each page.
- Making requests: base URLs, pages of results, sending a write again safely, dates and prices.
- API keys: creating a key, what it may do and what it can see.
- Errors: every code, grouped by what to do next.
- Limits: requests a minute, runs at once and other limits.
- Versioning and changes: what can change, and how you'll hear about it.
- Glossary: terms in plain English.
Changes to any API are listed in the changelog.