{ "openapi": "3.0.1", "info": { "title": "Pinterest Ad Library API - Ad Transparency Scraper", "description": "Access Pinterest's Ad Transparency Library. Search for advertiser names, retrieve active ads by country, categories, age range, or gender, and query specific ad creative details.", "version": "1.0", "x-build-id": "0N8W0wfqNfTqfbcz1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dev00~pinterest-ad-library-api-ad-transparency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dev00-pinterest-ad-library-api-ad-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/dev00~pinterest-ad-library-api-ad-transparency-scraper/runs": { "post": { "operationId": "runs-sync-dev00-pinterest-ad-library-api-ad-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/dev00~pinterest-ad-library-api-ad-transparency-scraper/run-sync": { "post": { "operationId": "run-sync-dev00-pinterest-ad-library-api-ad-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "action": { "title": "Action", "enum": [ "search_ads", "search_advertisers", "get_ad_details" ], "type": "string", "description": "Choose whether to search for ads, look up advertiser names, or retrieve ad details.", "default": "search_ads" }, "search": { "title": "Advertiser Search Text", "type": "string", "description": "Advertiser search text (e.g. google) - required when action is 'search_advertisers'." }, "country": { "title": "Country", "enum": [ "LT", "SE", "PL", "HR", "BG", "BR", "FI", "ES", "TR", "MT", "BE", "AT", "PT", "CZ", "SK", "GR", "LV", "IT", "DK", "DE", "LU", "IE", "SI", "CY", "EE", "HU", "NL", "NO", "RO", "FR" ], "type": "string", "description": "The country to filter ads from.", "default": "FR" }, "advertiser_name": { "title": "Exact Advertiser Name", "type": "string", "description": "Filter by exact advertiser name (e.g. Google LLC). Use 'Search Advertisers' action first to find exact names." }, "vertical": { "title": "Category Vertical", "enum": [ "", "ANIMALS", "ARCHITECTURE", "ART", "BEAUTY", "CHILDRENS_FASHION", "DESIGN", "DIY_AND_CRAFTS", "EDUCATION", "ELECTRONICS", "ENTERTAINMENT", "EVENT_PLANNING", "FINANCE", "FOOD_AND_DRINKS", "HEALTH", "HOME_DECOR", "GARDENING", "MENS_FASHION", "PARENTING", "QUOTES", "SPORT", "TRAVEL", "VEHICLES", "WEDDING", "WOMENS_FASHION", "OTHER" ], "type": "string", "description": "Filter ads by interest category vertical." }, "gender": { "title": "Gender", "enum": [ "", "UNSPECIFIED", "FEMALE", "MALE" ], "type": "string", "description": "Filter ads by target gender demographic." }, "age_bucket": { "title": "Age Bracket", "enum": [ "AGE_18_24", "AGE_25_34", "AGE_35_44", "AGE_45_49", "AGE_50_54", "AGE_55_64", "AGE_65_PLUS", "AGE_ALL" ], "type": "string", "description": "Filter ads by target age group.", "default": "AGE_ALL" }, "start_date": { "title": "Start Date", "type": "string", "description": "Start date for ad library transparency query." }, "end_date": { "title": "End Date", "type": "string", "description": "End date for ad library transparency query." }, "bookmark": { "title": "Pagination Bookmark", "type": "string", "description": "Pagination cursor token returned in previous runs." }, "ad_id": { "title": "Pinterest Ad ID", "type": "string", "description": "Pinterest Ad ID (e.g. 807973990291944766) - required when action is 'get_ad_details'." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }