The Places endpoint returns information about places like COVID-19 testing locations using HTTP requests. Places are defined within this API as establishments, geographic locations, or prominent points of interest.

­čÜž

Important

This feature is in beta. Feedback on data structure and response is welcome.

Places

You can request the API to return comprehensive details about the place like its geographical coordinates, title, address and phone number.

For COVID-19 testing sites, places include an array of services offered when available. Services provide information about the types of tests that are administered at this location.

propertytypedescription
categorystringType of place. For example TESTING_CENTER
latitudestringLatitude
longitudestringLongitude
titestringName of the place
descriptionstringDescription of the place
emailstringContact email
phoneArrayContact phone numbers
addressObjectContact address
servicesArrayServices offered by this place
tagsArrayTags for easy filtering

Sample Request

You can fetch nearby places by adding a latitude, longitude and radius filters to the request.

curl --location -g --request GET 'https://requirements-api.joinsherpa.com/v2/places?affiliateId=sherpa&key=<<API_KEY>>&language=en&filter[latitude]=19.4260333&filter[longitude]=-102.0510395&filter[radius]=10'
{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.7.0"
    },
    "data": [
        {
            "id": "22bd5959-706e-11eb-acf1-4563bd244d9c",
            "type": "PLACE",
            "attributes": {
                "category": "TEST_CENTER",
                "longitude": "-102.0553278",
                "latitude": "19.402666",
                "title": "Farmacias del Ahorro",
                "description": "Farmacias del Ahorro",
                "phone": [
                    {
                        "phoneNumber": ""
                    }
                ],
                "email": "",
                "website": "https://www.fahorro.com/antigen-test",
                "address": {
                    "fullAddress": "Paris S/N Jardines De Cupatitzio 60080 Uruapan Michoacan"
                },
                "services": [
                    {
                        "category": "ANTIGEN",
                        "type": "COVID_TEST",
                        "label": "Antigen Test"
                    }
                ],
                "tags": [
                    "ANTIGEN",
                    "ANTIGEN_TEST",
                    "COVID_TEST"
                ]
            }
        },
        {
            "id": "22bd595a-706e-11eb-acf1-4563bd244d9c",
            "type": "PLACE",
            "attributes": {
                "category": "TEST_CENTER",
                "longitude": "-102.0510395",
                "latitude": "19.4260333",
                "title": "Farmacias del Ahorro",
                "description": "Farmacias del Ahorro",
                "phone": [
                    {
                        "phoneNumber": ""
                    }
                ],
                "email": "",
                "website": "https://www.fahorro.com/antigen-test",
                "address": {
                    "fullAddress": "Benito Juarez 56 Francisco J Mujica 60050 Uruapan Michoacan"
                },
                "services": [
                    {
                        "category": "ANTIGEN",
                        "type": "COVID_TEST",
                        "label": "Antigen Test"
                    }
                ],
                "tags": [
                    "ANTIGEN",
                    "ANTIGEN_TEST",
                    "COVID_TEST"
                ]
            }
        }
    ],
    "included": []
}

Localization

Some of the content returned by the API is localized. Use the language query parameter to request information in a specific language.