ParuVendu Immobilier Reference API Documentation

GET https://scrappa.co/api/paruvendu-immo/reference

ParuVendu Immobilier Reference API lists the values that the other routes accept: listing types, property types, rooms, sort options, seller options, the agency areas and the limits of a search (30 results per page, 5 pages, 150 results per query). No data is fetched from the source, so the route is fast.

Run this endpoint

ParuVendu Immobilier Reference API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/paruvendu-immo/reference

Auth header: x-api-key
Cost: 1 credit/request

Response preview

200 OK

{
    "data": {
        "currency": "EUR",
        "max_page": 5,
        "page_size": 30,
        "listing_types": [
            {
                "key": "sale",
                "label": "For sale"
            },
            {
                "key": "rent",
                "label": "For rent"
            }
...

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Open in Playground

Example response fields

Scan these fields before integrating.

data success

JSON Response

200 OK

{
    "data": {
        "currency": "EUR",
        "max_page": 5,
        "page_size": 30,
        "listing_types": [
            {
                "key": "sale",
                "label": "For sale"
            },
            {
                "key": "rent",
                "label": "For rent"
            }
        ],
        "property_types": [
            {
                "key": "apartment",
                "label": "Apartment"
            }
        ],
        "max_reachable_results": 150
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "field": [
            "The field is invalid."
        ]
    },
    "message": "The request validation failed"
}

503

Upstream Unavailable

ParuVendu Immobilier could not be reached. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "reference"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "ParuVendu Immobilier could not be reached. Please retry shortly."
    },
    "success": false
}

503

Unexpected Upstream Data

ParuVendu Immobilier returned data in an unexpected shape. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "reference"
    },
    "error": {
        "code": "INVALID_UPSTREAM_SHAPE",
        "message": "ParuVendu Immobilier returned data in an unexpected shape. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.