Digital Platform API - Country service

Article
01/16/2025

The read-only Country Service allows you to see information about the countries/regions registered in the Xandr system. You can use this service to retrieve the ID for targeting in campaigns (see country_targets in the Profile Service).

REST API

HTTP Method	Endpoint	Description
`GET`	https://api.appnexus.com/country	View all countries/regions.
`GET`	https://api.appnexus.com/country?id=ID	View a specific country/region by ID.
`GET`	https://api.appnexus.com/country?name=NAME	View a specific country/region by NAME.
`GET`	https://api.appnexus.com/country?code=CODE	View a specific country/region by CODE.
`GET`	https://api.appnexus.com/country/meta	Find out which fields you can filter and sort by.

JSON fields

Field	Type	Description
`id`	int	The ID of the country/region.
`name`	string	The name of the country/region.
`code`	string	The ISO code for the country/region.
`active`	Boolean	If true, the country/region is available for targeting. If false, there is no geolocation data for the country/region and so delivery is not possible.

Examples

View all countries/regions

$ curl -b cookies -c cookies 'https://api.appnexus.com/country'
{
    "response": {
        "status": "OK",
        "count": 250,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 1,
                "name": "Anonymous Proxy",
                "code": "A1",
                "active": true
            },
            {
                "id": 2,
                "name": "Satellite Provider",
                "code": "A2",
                "active": true
            },
            {
                "id": 3,
                "name": "Other Country",
                "code": "O1",
                "active": true
            },
            ...
        ]
    }
}

View a specific country/region by ID

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?id=59'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "country": {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
        }
    }
}

View a specific country/region by code

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?code=DE'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 59,
                "name": "Germany",
                "code": "DE",
                "active": true
            }
        ]
    }
}

View all countries/regions that contain "United" in their names

$ curl -b cookies -c cookies 'https://api.appnexus.com/country?like_name=United'
{
    "response": {
        "status": "OK",
        "count": 5,
        "start_element": null,
        "num_elements": null,
        "countries": [
            {
                "id": 5,
                "name": "United Arab Emirates",
                "code": "AE",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "GB",
                "active": true
            },
            {
                "id": 229,
                "name": "Tanzania, United Republic of",
                "code": "TZ",
                "active": true
            },
            {
                "id": 232,
                "name": "United States Minor Outlying Islands",
                "code": "UM",
                "active": true
            },
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            }
        ]
    }
}

Share via