search

Get Availability Requests

After an availability request is created, the data is gathered asynchronously from all sources that match the provided address and filters. The current state of the availability requests can be viewed as follows.

GET /availability-requests
Response
{
    "data": [
        {
            "id": "63e3b06f9d021699ad0c0442",
            "address": {
                "id": "63e3b06f9d021699ad0c0443",
                "street": "Lijnbaansgracht",
                "city": "Amsterdam",
                "continent_code": "EU",
                "country_code": "NL",
                "postal_code": "1016XA",
                "house_number": "206",
                "house_number_addition": "H",
                "coordinates": {
                    "latitude": 52.36800976742718,
                    "longitude": 4.8791514526625805
                },
                "_document_type": "address"
            },
            "created_at": "2023-02-08T14:23:43+00:00",
            "updated_at": "2023-02-08T14:23:46+00:00",
            "filters": {
                "contract_terms": [],
                "connection_types": [],
                "bandwidths": [],
                "technology_types": [],
                "networks": []
            },
            "networks_progress_percentage": "60.87",
            "_document_type": "availability_request"
        }
        {
            "id": "63e2815851345f22c50856d3",
            "address": {
                "id": "63e2815851345f22c50856d4",
                "street": "Northumberland Avenue",
                "city": "London",
                "continent_code": "EU",
                "country_code": "GB",
                "postal_code": "WC2N 5BW",
                "house_number": "1",
                "house_number_addition": "",
                "coordinates": {
                    "latitude": 51.5071847,
                    "longitude": -0.1272394
                },
                "_document_type": "address"
            },
            "created_at": "2023-02-07T16:50:32+00:00",
            "updated_at": "2023-02-07T16:50:35+00:00",
            "filters": {
                "contract_terms": [],
                "connection_types": [],
                "bandwidths": [],
                "technology_types": [],
                "networks": []
            },
            "networks_progress_percentage": "100.00",
            "_document_type": "availability_request"
        }
    ],
    "sse_jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NzU4NzE2NDMuMzk2MjczLCJtZXJjdXJlIjp7InB1Ymxpc2giOltdLCJzdWJzY3JpYmUiOlsiNjM3NjA2MTE3MmY1ZTdiYmJiMGExZWQyL2F2YWlsYWJpbGl0eV9yZXF1ZXN0Il19fQ.YRA5ebo8ihOZRvWuZ3NGxlV3OE1jShwPB1UONWIgU4o",
    "pagination": {
        "page_size": 1,
        "current_page": 1,
        "total_items": 2,
        "total_pages": 1
    }
}

Results are paginated. Pagination details can be found at the bottom.

Accessing the second-page for example can be done as follows.

The Availability request has a status field. The possible values are 'pending', 'in_progress' and 'completed'. You can retrieve the status using the endpoint below.

The id indicates the unique identifier of the availability request. This value can be used to retrieve an availability request with all its details.

PreviousCreate an Availability RequestNextServer Sent Events

Last updated