Search Facebook Ad Library ads

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request GET \
  --url 'https://api.aisa.one/apis/v1/facebook/ad-library/ads/search?query=nike' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/facebook/ad-library/ads/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/facebook/ad-library/ads/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

GET

https://api.aisa.one

apis

facebook

ad-library

ads

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request GET \
  --url 'https://api.aisa.one/apis/v1/facebook/ad-library/ads/search?query=nike' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/facebook/ad-library/ads/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.aisa.one/apis/v1/facebook/ad-library/ads/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/facebook/ad-library/ads/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Request contract

Method and path: GET /apis/v1/facebook/ad-library/ads/search
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/facebook/ad-library/ads/search
adType: query; optional
country: query; optional
cursor: query; optional
endDate: query; optional
language: query; optional
mediaType: query; optional
query: query; required
searchType: query; optional
sortBy: query; optional
startDate: query; optional
status: query; optional
trim: query; optional
Runtime facts: dc9b77b2e3a08457a2eca6be9d001a549785561f83b492abe3e3462b92be5843

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "facebook.ad-library.ads.search",
  "method": "GET",
  "path": "/apis/v1/facebook/ad-library/ads/search",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "in": "query",
      "name": "adType",
      "required": false,
      "schema": {
        "enum": [
          "all",
          "political-and-issue"
        ],
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "country",
      "required": false,
      "schema": {
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "required": false,
      "schema": {
        "maxLength": 16384,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "endDate",
      "required": false,
      "schema": {
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "language",
      "required": false,
      "schema": {
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "mediaType",
      "required": false,
      "schema": {
        "enum": [
          "all",
          "image",
          "image-and-meme",
          "meme",
          "none",
          "video"
        ],
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "examples": {
        "default": {
          "value": "nike"
        },
        "minimal": {
          "value": "nike"
        }
      },
      "in": "query",
      "name": "query",
      "required": true,
      "schema": {
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "searchType",
      "required": false,
      "schema": {
        "enum": [
          "exact-phrase",
          "keyword-unordered"
        ],
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "sortBy",
      "required": false,
      "schema": {
        "enum": [
          "impressions",
          "most-recent"
        ],
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "startDate",
      "required": false,
      "schema": {
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "status",
      "required": false,
      "schema": {
        "enum": [
          "active",
          "all",
          "inactive"
        ],
        "maxLength": 4096,
        "minLength": 1,
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "trim",
      "required": false,
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "response_units",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 0.014,
    "estimate_source": "profile_seed",
    "evidence_source": "response_body",
    "maximum_units": 1,
    "unit": "provider_credit",
    "unit_rate_usd": 0.014
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Usage-based billing; Default request estimate: $0.014 USD (not a fixed price). Declared unit rate: $0.014 USD per provider_credit. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.014
Declared unit rate (USD): 0.014
Billing unit: provider_credit
Cost contract: response_units
Published reference multiplier: 1.0
Declared maximum count/units: 1
Settlement evidence source: response_body

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

adType

enum<string>

Available options:

all,

political-and-issue

Required string length: 1 - 4096

country

string

Required string length: 1 - 4096

cursor

string

Required string length: 1 - 16384

endDate

string

Required string length: 1 - 4096

language

string

Required string length: 1 - 4096

mediaType

enum<string>

Available options:

all,

image,

image-and-meme,

meme,

none,

video

Required string length: 1 - 4096

query

string

required

Required string length: 1 - 4096

searchType

enum<string>

Available options:

exact-phrase,

keyword-unordered

Required string length: 1 - 4096

sortBy

enum<string>

Available options:

impressions,

most-recent

Required string length: 1 - 4096

startDate

string

Required string length: 1 - 4096

status

enum<string>

Available options:

active,

all,

inactive

Required string length: 1 - 4096

trim

boolean

Response

Successful response

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Response

Request contract

Cost and request rules