👋 Introduction

Listings export API allows users to start extracting the listing data from the earlier subscribed data as a service product. Our export data provides a rich amount of the information from our listing platform enabling many different types of customers to excel their businesses, make informed decisions using data. The data in listing covers many information including location, prices, energy consumptions and certifications, building and structure information , features and type of estate

🔐 Authentication

Access to the Aviv Platform Export Listings API is currently limited. If you are interested in using this API, please contact our contact team at connect@aviv-group.com.

All the API endpoints use the OAuth 2.0 protocol. As soon as you get your personal client credentials from the customer support team, you will be allowed to generate an access token that will enable you to access all the features related to your usage plan.

💻 API overview

The Aviv Platform Export Listings API is a RESTful API. The API allows you to interact with resources using verbs: POST, GET.

• To request a new Listings export: use the POST verb with the resource name

  POST /request-listings-export/

• To retrieve an existing resource: use the GET verb with the resource name
  and its unique identifier

  GET /get-export-status/:exportRequestId

  The file generation is handled by an asynchronous process that begins once your request is received. This non-blocking approach allows your application to continue other operations without delay. The system processes your request in the background, retrieving and formatting the relevant data into a predefined structure. When completed, the file will be made available via a secure, temporary download URL provided in the response.

Naming conventions

• The supported format is JSON.

• The fields are defined in camelCase.

• The boolean fields start by a “is” prefix.

Specification

The Aviv Platform Export Listings API follows the OpenAPI specification.

Supported HTTP status codes

• 2xx for successful operations
• 4xx for client errors
• 5xx for server errors

🚨 Error handling This section documents the error responses returned by the API.

  Each error includes a code, message, and additional details to help
  identify and resolve issues.


  Common error codes:

  - **400**: Bad Request - Invalid or missing data.

  - **401**: Unauthorized - Invalid or missing authentication.

  - **403**: Forbidden - Insufficient permissions.

  - **404**: Not Found - Resource does not exist.

  - **500**: Internal Server Error - Unexpected server error.


  For details on error structure, refer to the Error schema below

## Internal Server Error
Represents an internal server error.

This error occurs when an unexpected problem occurs on the server side.

The response includes a status code, title, and instance ID to help identify the problem.

##  Bad Request Error
Represents a bad request error.

This error occurs when the server cannot process the request due to something
that is perceived to be a client error (e.g., malformed request syntax, invalid
request parameters, or deceptive request routing)

The response includes a status code, title, and may include additional details
about the specific problem with the request.

## Not Found Error
Represents a not found error.

This error occurs when the server cannot find the requested resource.
This could be due to a mistyped URL, a deleted resource,
or a resource that the user does not have permission to access.

The response includes a status code, title,
and may include additional details about the missing resource.