{ "openapi": "3.0.1", "info": { "title": "LinkedIn Ad Library Scraper", "description": "Scrape public LinkedIn Ad Library ads by keyword, advertiser, country, and official search URLs.", "version": "0.1", "x-build-id": "CnjkVtoZ9IavfZgt5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~linkedin-ad-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-linkedin-ad-library-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/fetch_cat~linkedin-ad-library-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-linkedin-ad-library-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/fetch_cat~linkedin-ad-library-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-linkedin-ad-library-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": { "startUrls": { "title": "Official Ad Library search URLs", "type": "array", "description": "Paste official LinkedIn Ad Library search URLs. These are processed in addition to any keyword, advertiser or payer search; clear the query fields for a URL-only run. Provide at least one URL or query field.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keyword": { "title": "Keyword", "type": "string", "description": "Search public ad text by keyword. Supply a keyword, advertiser, payer or official search URL. When query fields and startUrls are both supplied, both searches are processed." }, "advertiser": { "title": "Advertiser / account owner", "type": "string", "description": "Optional advertiser/account owner name for LinkedIn's accountOwner filter." }, "payer": { "title": "Payer name", "type": "string", "description": "Optional payer name for LinkedIn's paidBy filter." }, "countries": { "title": "Countries", "type": "array", "description": "ISO country codes to include, such as US, GB, CA, AU.", "default": [ "US" ], "items": { "type": "string" } }, "dateOption": { "title": "Date range", "enum": [ "last-30-days", "last-6-months", "last-year", "any-time" ], "type": "string", "description": "LinkedIn Ad Library date filter.", "default": "last-30-days" }, "changedSince": { "title": "Changed since", "type": "string", "description": "Optional ISO timestamp compared with the current extraction time. Records are labeled unchanged only when extracted before this timestamp; otherwise they are new. This does not filter ads, compare creative changes or remember ads from previous runs." }, "maxAds": { "title": "Maximum ads", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique ad records saved across all searches, from 1 to 1000. The Console/schema default is 20; specify this explicitly in API requests for a predictable bound.", "default": 20 }, "requestDelayMs": { "title": "Delay between ad detail requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Throttle detail requests to reduce LinkedIn rate limits. Increase this for larger monitoring runs.", "default": 750 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The form defaults to Apify Proxy from the first request, using residential proxies for the first selected country (US when omitted) unless a managed group is supplied. Managed settings and custom proxy URLs are supported. Set useApifyProxy to false with no custom URLs for direct requests. There is no automatic switch from direct access to a paid proxy. Malformed settings are rejected rather than enabling a managed route.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }