Using the API
Authentication
The API endpoints for our Ads library are open for use by 3rd parties and do not require an OAuth token.
Get Ads By Brand Search
The search method takes up to five different parameters in a JSON formatted body and returns all matching Ads in the Ads library.
HTTP Request
POST https://adsapi.snapchat.com/v1/ads_library/ads/search
Request Parameters
Parameter Name | Data Type |
---|---|
cursor | string |
Body Parameters
Parameter Name | Data Type | Description | Possible values |
---|---|---|---|
countries | Array of strings | 2 letter ISO country code | de,be,fi,pt,bg,dk,lt,lu,hr,lv,fr,hu,se,si,sk,ie,ee,el,mt,it,es,at,cy,cz,pl,ro,nl |
start_date | DATE | Start Date | |
end_date | DATE | End Date | |
status | string | Status of the ad | ACTIVE, PAUSED |
paying_advertiser_name | string | Name of the advertiser paying for the ad |
Example Request
curl -X POST \
-d '{"paying_advertiser_name":"badger","countries":["fr","de"],"start_date": "2024-01-01T00:00:00.000Z","end_date": "2024-12-31T00:00:00.000Z","status": "PAUSED"}' \
-H "Content-Type: application/json" \
https://adsapi.snapchat.com/v1/ads_library/ads/search
Response
{
"request_status": "SUCCESS",
"request_id": "1234567890…",
"paging": {
"next_link": "https://adsapi.snapchat.com/v1/ads_library/ads/search?cursor=ABCDEFG"
},
"ad_previews": [
{
"sub_request_status": "SUCCESS",
"ad_preview": {
{{ad_preview_fields}}
}
},
{
"sub_request_status": "SUCCESS",
"ad_preview": {
{{ad_preview_fields}}
}
}
]
}
Get Ad Details
HTTP Request
GET https://adsapi.snapchat.com/v1/ads_library/ads/{ad_id}
Example Request
curl "https://adsapi.snapchat.com/v1/ads_library/ads/{ad_id}"
Response
{
"request_status": "SUCCESS",
"request_id": "1234567890…",
"ad_preview": {
{{ad_preview_fields}}
}
}
Get Organic Content
HTTP Request
GET https://adsapi.snapchat.com/v1/ads_library/sponsored_content?cursor=ABCDEFG
Example Request
curl "https://adsapi.snapchat.com/v1/ads_library/sponsored_content?cursor=ABCDEFG"
Response
{
"request_status": "SUCCESS",
"request_id": "1234567890…",
"paging": {
"next_link": "http://adsapisc.appspot.com/v1/ads_library/sponsored_content?cursor=ABCDEFG",
},
"organic_content": [
{
"sub_request_status": "SUCCESS",
"organic_content": {
{{organic_content_fields}}
}
},
{
"sub_request_status": "SUCCESS",
"organic_content": {
{{organic_content_fields}}
}
}
]
}
Get Organic Content by Creator Search
The search method takes one parameter in a JSON formatted body and returns all matching Ads in the Ads library.
HTTP Request
POST https://adsapi.snapchat.com/v1/ads_library/sponsored_content/search
Request Parameters
Parameter Name | Data Type | Possible values |
---|---|---|
cursor | string | |
limit | integer |
Body Parameters
Parameter Name | Data Type | Description | Possible values |
---|---|---|---|
creator_name | string | Name of the creator |
Example Request
curl -X POST \
-d '{"creator_name":"honeybear"}' \
-H "Content-Type: application/json" \
https://adsapi.snapchat.com/v1/ads_library/sponsored_content/search
Response
{
"request_status": "SUCCESS",
"request_id": "c51d3807-8d10-48f2-86be-57e95953da4c",
"paging": {
"next_link": "https://adsapi.snapchat.com/v1/ads_library/sponsored_content/search?cursor=ABCDEFG"
},
"ad_previews": [
{
"sub_request_status": "SUCCESS",
"sponsored_content_preview": {
{{sponsored_content_preview_fields}}
}
},
{
"sub_request_status": "SUCCESS",
"sponsored_content_preview": {
{{sponsored_content_preview_fields}}
}
}
}
]
}