The API (Application Programming Interface) is a technical interface that enables data to be transferred automatically from one system to another. In practice, this means that listings published in Linear and their public information can be used in any digital channel without having to enter the data manually in multiple places.
An API integration is the best option when you want to build a fully customized solution for utilizing listing data. It offers freedom and flexibility, but it also requires more technical implementation compared to ready-made add-ons.
With an API integration, you can for example:
- Create a custom listing page for your company website.
- Display listings on TV screens in your office window.
- Export listing data to external systems, such as marketing tools or platforms.
Good to know before implementing an API integration
While the API offers versatile possibilities, making use of it often requires more development work than ready-made add-ons, such as a WordPress plug-in. Implementing the integration usually requires a developer who works with websites or system integrations.
Before starting the project, it is recommended to discuss with the implementing developer:
- how extensive the integration needs to be
- what kind of costs the development work may involve
- how the connection to Linear’s API will be maintained in the future
API documentation
You can find the detailed API documentation for listing data ("listings") in Swagger:
https://linear-external-api.azurewebsites.net/api#/Listings/ExternalListingsController_externalListingsApi
Recommended endpoints for website integrations:
- v2/listings/performance – use this once per night to retrieve all listings published in Linear at the group level.
- v2/listings/update – use this for continuous updates (e.g. every 5 minutes). This endpoint returns only updated and deleted listings, making data synchronization efficient and lightweight.
For more information about the brokerage firm’s API key and pricing, please contact Linear’s customer support.
Testing the API
You can also test the API connection using Linear’s test data. Documentation can be found in Swagger:
https://external-api.lineartestlab.com/api#/
The test API endpoint is:
https://external-api.lineartestlab.com/v2/
API key for testing:
LINEAR-API-KEY b6b23692-e3fa-4525-9709-e021c8a65baa(Note: make sure to include the prefix "LINEAR-API-KEY")