https://api.nexscope.ai/social/facebook/adLibrary/search/adsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/social/facebook/adLibrary/search/ads |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | required | Keyword to search for Example: running |
sort_by | string | optional | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. |
search_type | string | optional | If you want to search by exact phrase or not |
ad_type | string | optional | Search for all ads or only political and issue ads |
country | string | optional | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. |
language | string | optional | Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. |
status | string | optional | Status of the ad. Defaults to ACTIVE. |
media_type | string | optional | Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme. |
start_date | string | optional | Impressions start date. Needs to be in YYYY-MM-DD format. |
end_date | string | optional | Impressions end date. Needs to be in YYYY-MM-DD format. |
trim | boolean | optional | Set to true for a trimmed down version of the response |
cursor | string | optional | Cursor to paginate through results |
Social data contract
Use your Nexscope API key. No supplier credentials are required. Requests reject unknown fields, including pageSize. URLs require HTTPS and an exact supported platform host and resource path. Documented YouTube video URLs may use youtu.be; other short links are unsupported. Check the request schema for supported fields and defaults.
Each request fetches one page. Continue manually with the returned nextCursor, or nextPage for Instagram Reels (pages 1–11). Cursors are opaque, unchanged strings up to 65536 UTF-8 bytes. No automatic pagination, retry, media download or transcription is performed. Repeated requests may purchase data again.
Resource status is independent of HTTP and billing: AVAILABLE, PARTIAL, PRIVATE, RESTRICTED, NOT_FOUND, NO_TRANSCRIPT or UNKNOWN can accompany code 0. Unknown values remain null; arrays remain empty arrays. fetchedAt is the response observation time; sourceFetchedAt is null without source evidence.
usage.billingStatus is NOT_CHARGED, SETTLED or UNKNOWN; chargedCredits is null when unconfirmed. Unknown charges never mean free. Completed lookups have a minimum charge of 10 credits, including cached, no-caption and unavailable-resource results; check API usage records for the actual charge. Parameter errors and unpublished APIs use the standard error envelope; upstream failures use code 13007, rate limits 429 and timeouts 408. Always check code and msg.
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"cursor": "AQHRLKHyzb3ZNTn1O3qr6lG7ncS9gfboI0HWGSDETVUnipTSXVY8E4Wb-568JBicOvYS",
"searchResults": [
{
"ad_archive_id": "1378176106734781",
"end_date": 1747638000,
"end_date_string": "2025-05-19T07:00:00.000Z",
"is_aaa_eligible": false,
"is_active": true,
"page_id": "119749581219299",
"page_name": "Makhumalo",
"political_countries": [],
"publisher_platform": [
"FACEBOOK"
],
"reach_estimate": null,
"snapshot": {
"additional_info": null,
"body": {
"text": "This is my second pair. I only take them off to go to sleep. I put them on first thing in the morning. I am 59 and have neuropathy in my feet, they bring me comfort every day.” -Lydia P.👍👍👍\n❤️These orthopedic shoes provide great comfort and ease foot and knee pain! 😍\n✅ Ideal for wide feet \n✅ comfortable \n✅ they are ideal for everyday life.\nGet Yours Now : https://www.ghemshop.com/products/buckled-square"
},
"branded_content": null,
"brazil_tax_id": null,
"byline": null,
"caption": "ghemshop.com",
"cards": [],
"country_iso_code": null,
"cta_text": "Shop now",
"cta_type": "SHOP_NOW",
"current_page_name": "Makhumalo",
"disclaimer_label": null,
"display_format": "IMAGE",
"ec_certificates": [],
"event": null,
"extra_images": [],
"extra_links": [],
"extra_texts": [],
"extra_videos": [],
"images": [
{
"image_crops": [],
"original_image_url": "https://scontent-sjc3-1.xx.fbcdn.net/v/t39.35426-6/499507599_4016645891948767_4341363175504946673_n.jpg?_nc_cat=105&ccb=1-7&_nc_sid=c53f8f&_nc_ohc=3EJ6TbZR3GEQ7kNvwErfuF4&_nc_oc=AdkQPpJ9OYN_J3P5xTetGSb9FDCFZzfoLSj59Bbp6s-g5HGg-zTECrgOm8mjkJfk5JE&_nc_zt=14&_nc_ht=scontent-sjc3-1.xx&_nc_gid=49D7P4N6a4mVqUW8WdOxag&oh=00_AfMTuIozb2-VJgGP7NCIx0pG91b48CzMgm_1eT7STgBvew&oe=685A6906",
"resized_image_url": "https://scontent-sjc3-1.xx.fbcdn.net/v/t39.35426-6/499504336_1222720305887055_488411876974522066_n.jpg?stp=dst-jpg_s600x600_tt6&_nc_cat=104&ccb=1-7&_nc_sid=c53f8f&_nc_ohc=DYkDYH-EJrQQ7kNvwF-b_ov&_nc_oc=Adn2l2fDwHaN4h6W-OxxgoYkb0IUAeCpYH5bociuO_oxVL9L0wLg5vqnNfJa0ehQwqY&_nc_zt=14&_nc_ht=scontent-sjc3-1.xx&_nc_gid=49D7P4N6a4mVqUW8WdOxag&oh=00_AfNkQcMpUNFcM7tF1M5tAHmVwABzLx5QKUU8CFo69NP3Rg&oe=685A4518",
"watermarked_resized_image_url": ""
}
],
"is_reshared": false,
"link_description": "🔥Best Seller-Last Day Sale 60% OFF🔥 Buckled Square Heel Sandals for Women",
"link_url": "https://www.ghemshop.com/products/buckled-square",
"page_categories": [
"Musician"
],
"page_entity_type": "PERSON_PROFILE",
"page_id": "119749581219299",
"page_is_deleted": false,
"page_is_profile_page": false,
"page_like_count": 7,
"page_name": "Makhumalo",
"page_profile_picture_url": "https://scontent-sjc3-1.xx.fbcdn.net/v/t39.35426-6/499107970_2293645317822147_4932735414928456888_n.jpg?stp=dst-jpg_s60x60_tt6&_nc_cat=106&ccb=1-7&_nc_sid=c53f8f&_nc_ohc=DBNo3Z6ft4AQ7kNvwESjMWN&_nc_oc=AdnZGvglABgVlSJ6UIGIbWgFeUL2LnoBSuMbBvti20zRjb_UUDRzhGxAZ0ip3ye1EQI&_nc_zt=14&_nc_ht=scontent-sjc3-1.xx&_nc_gid=49D7P4N6a4mVqUW8WdOxag&oh=00_AfMEXcKVf3KYJpFehTTToe8MXUZslTHE9P-xS2eyVCeGKA&oe=685A4903",
"page_profile_uri": "https://www.facebook.com/61550737114480/",
"root_reshared_post": null,
"title": "🔥Best Seller-Last Day Sale 60% OFF🔥 Buckled Square Heel Sandals for Women",
"videos": []
},
"spend": null,
"start_date": 1747638000,
"start_date_string": "2025-05-19T07:00:00.000Z",
"total_active_time": null,
"url": "https://www.facebook.com/ads/library?id=1378176106734781"
}
],
"searchResultsCount": 50001,
"success": true
},
"platform": "facebook-ad-library",
"resourceStatus": "AVAILABLE",
"usage": {
"billingStatus": "UNKNOWN"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1 — requires platform, resourceStatus, data, usage
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.data | object | required | Data value used by this API operation. |
data.platform | string | required | Platform value used by this API operation. |
data.resourceStatus | string | required | Resource status value used by this API operation. |
data.usage | object | required | Usage value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.