Regions

Get Facebook Ad Regions by Name

GET /ads/facebook/regions

cURL

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

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/ads/facebook/regions?search=al"

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/ads/facebook/regions?search=al", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://api.ayrshare.com/api/ads/facebook/regions?search=al', headers=headers)

print(r.json())

<?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ayrshare.com/api/ads/facebook/regions?search=al",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer API_KEY"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Authorization", "Bearer API_KEY");

        var response = await client.GetAsync("https://api.ayrshare.com/api/ads/facebook/regions?search=al");
        var content = await response.Content.ReadAsStringAsync();

        Console.WriteLine(content);
    }
}

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://api.ayrshare.com/api/ads/facebook/regions?search=al", nil)
    req.Header.Add("Authorization", "Bearer API_KEY")

    resp, _ := client.Do(req)
    body, _ := ioutil.ReadAll(resp.Body)

    fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetAdRegions {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.ayrshare.com/api/ads/facebook/regions?search=al"))
                .header("Authorization", "Bearer API_KEY")
                .GET()
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://api.ayrshare.com/api/ads/facebook/regions?search=al')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer API_KEY'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http|
  http.request(req)
}

puts res.body

200: Success

{
  "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
}

{
  "action": "ads",
  "status": "error",
  "code": 414,
  "message": "Error getting ad location metadata. Please try again."
}

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

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.

cURL

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

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/ads/facebook/regions?search=al"

const API_KEY = "API_KEY";

fetch("https://api.ayrshare.com/api/ads/facebook/regions?search=al", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://api.ayrshare.com/api/ads/facebook/regions?search=al', headers=headers)

print(r.json())

<?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ayrshare.com/api/ads/facebook/regions?search=al",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer API_KEY"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>

using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        var client = new HttpClient();
        client.DefaultRequestHeaders.Add("Authorization", "Bearer API_KEY");

        var response = await client.GetAsync("https://api.ayrshare.com/api/ads/facebook/regions?search=al");
        var content = await response.Content.ReadAsStringAsync();

        Console.WriteLine(content);
    }
}

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://api.ayrshare.com/api/ads/facebook/regions?search=al", nil)
    req.Header.Add("Authorization", "Bearer API_KEY")

    resp, _ := client.Do(req)
    body, _ := ioutil.ReadAll(resp.Body)

    fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetAdRegions {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.ayrshare.com/api/ads/facebook/regions?search=al"))
                .header("Authorization", "Bearer API_KEY")
                .GET()
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://api.ayrshare.com/api/ads/facebook/regions?search=al')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer API_KEY'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http|
  http.request(req)
}

puts res.body

200: Success

{
  "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
}

{
  "action": "ads",
  "status": "error",
  "code": 414,
  "message": "Error getting ad location metadata. Please try again."
}