What APIs do we provide

Thank you for showing interest in the OLX RE API. Let's get started.

What can the OLX RE API do?

The OLX RE API provides instant access to our Real Estate marketplace portals, enabling your clients to engage with thousands of users.


API High Level Diagram

By leveraging the OLX RE API, you can empower your clients with a range of features accessible through your CRM:

  • Advert Management - Publishing adverts is the main reason you're here for. You can manage adverts posted through the Advert API and receive lifecycle updates from the portal. Learn more here.
  • Promotions Management - Your application can promote adverts through the VAS API and receive lifecycle updates from the portal. Learn more here.
  • Lead Delivery - Your application can receive leads (messages) from users in real-time.

Through the API, you also will be able to:

  • Contact customization - You can customize the contact information in adverts by sending us the consultant's information (name, email, and photo).
  • Publish in Volume - Our API is capable of handling high throughputs to accommodate your needs, and we encourage you to implement capability on your end as well. Learn more about our Service-level agreement.
  • Webhook Notification System - Whenever you send a request, we will notify you upon completion. It's crucial for the user to see all notifications in the CRM so they know how to proceed if a request fails. Ensure your server is ready to respond with an acknowledgment as soon as you receive a webhook. If we don't receive an acknowledgment, we'll attempt a few more times before stopping. See the below diagram.

Async API Diagram

What is required to use the API?

Did you go through all available features and you want to integrate with our APIs? Please visit our page on how to Request An Application, where you will find all the necessary information.

What more do I need to know?

All APIs are available through REST endpoints and accept JSON as the content type for requests and corresponding responses. Each one has its version number and authentication requirements.

The generic structure for our APIs endpoint is: https://api.olxgroup.com/<api>/<version>

For example, the endpoint to manage the adverts resource using the Adverts API version v1 looks like this: https://api.olxgroup.com/advert/v1.

Check out all the available APIs:

OAuth2Authorisation Management based on the OAuth2.0 Protocolv1/oauth
Advert APIAdvert Management Servicev1/advert
VAS APIApplying for Promotionsv1/vas
Taxonomy APIUnique Resource Descriptor for Advert Characteristicsv1/taxonomy

Before starting the integration, there is an essential concept that you need to know: URNs (Uniform Resource Names). We use URNs in a lot of places in the APIs. They are used to identify Categories, Attributes, Sites, and more. You can check the Taxonomy URNs and the Supported Sites URNs for more information.

Taxonomy API is an additional API that will help you on the beginning to map of all attributes for the adverts. It's crucial to make sure you have mapped our taxonomy before going live. Certain parts of the taxonomy are mandatory, and your application won't be able to publish adverts without them. Furthermore, categories and attributes contribute significantly to the quality of the ads that your customers will post.