Skip to main content
GET
/
ads
/
facebook
/
regions
# All countries that support region targeting
curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/ads/facebook/regions"

{
  "status": "success",
  "regions": [
    {
      "key": "3843",
      "name": "Alabama",
      "type": "region",
      "countryCode": "US",
      "countryName": "United States",
      "supportsRegion": true,
      "supportsCity": true
    },
    {
      "key": "3844",
      "name": "Alaska",
      "type": "region",
      "countryCode": "US",
      "countryName": "United States",
      "supportsRegion": true,
      "supportsCity": true
    }
  ],
  "count": 2
}

Documentation Index

Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Available on plan.
Search for regions (states, provinces, etc.) to be used for targeting when boosting an ad.
  • Regions use Facebook’s key identifier. Use this key when boosting ads with region targeting.
  • If a returned region has supportsRegion true, you can target this region. If supportsCity is true, the region has city codes.
  • To get all countries that support region targeting, call this endpoint without query parameters.
  • Results may vary based on Facebook data availability.

​
Header Parameters

​
Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
​
Profile-Key
string
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

​
Query Parameters

​
search
string
The search string to filter regions. Provide a partial or full region name.
​
limit
number
default:25
Maximum number of regions to return.
# All countries that support region targeting
curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/ads/facebook/regions"

{
  "status": "success",
  "regions": [
    {
      "key": "3843",
      "name": "Alabama",
      "type": "region",
      "countryCode": "US",
      "countryName": "United States",
      "supportsRegion": true,
      "supportsCity": true
    },
    {
      "key": "3844",
      "name": "Alaska",
      "type": "region",
      "countryCode": "US",
      "countryName": "United States",
      "supportsRegion": true,
      "supportsCity": true
    }
  ],
  "count": 2
}