{ "openapi": "3.0.1", "info": { "title": "LinkedIn Ads Scraper - Ad Library Data, $0.25 per 1,000 Ads", "description": "The company an ad is for and the company paying for it are not always the same. The LinkedIn Ad Library names both. Search either, plus keyword and country. One row per ad: copy, headline, CTA, creative, landing URL, format, dates and impressions where shown. $0.25/1,000 ads.", "version": "0.1", "x-build-id": "L744EvvlPL8DG24Hs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~linkedin-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-linkedin-ads-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/dami_studio~linkedin-ads-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-linkedin-ads-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/dami_studio~linkedin-ads-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-linkedin-ads-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": { "companies": { "title": "Companies / advertisers", "minItems": 0, "maxItems": 20, "type": "array", "description": "Company names as they appear on LinkedIn (\"HubSpot\"), or LinkedIn company URLs (https://www.linkedin.com/company/hubspot). Up to 20 per run. A URL with a numeric id filters exactly; a name or a vanity URL matches the advertiser name, which can catch more than one page.", "items": { "type": "string" } }, "keywords": { "title": "Keywords in the ad copy", "minItems": 0, "maxItems": 20, "type": "array", "description": "Words or phrases searched inside the text of the ad. Several words in one entry are combined with AND. Up to 20 per run.", "items": { "type": "string" } }, "payers": { "title": "Payer names", "minItems": 0, "maxItems": 20, "type": "array", "description": "The entity that paid for the ad, which is often a media agency rather than the brand. Useful for mapping an agency's whole client roster. Up to 20 per run.", "items": { "type": "string" } }, "countries": { "title": "Countries", "minItems": 0, "maxItems": 20, "type": "array", "description": "Two-letter ISO country codes, e.g. DE, FR, US. Applied to every search above. Give countries on their own to sweep everything advertised into that country. Tip: an EU country here also switches on the run dates, impressions and targeting fields, which LinkedIn only discloses for ads delivered into the EU.", "items": { "type": "string" } }, "dateRange": { "title": "Date range", "enum": [ "all", "last-30-days", "current-month", "current-year", "last-year" ], "type": "string", "description": "Limit results to ads served in this window. Leave on \"all\" for everything the library holds." }, "dateFrom": { "title": "Custom start date", "type": "string", "description": "YYYY-MM-DD. Fill both custom dates to use an exact window instead of the preset above. LinkedIn only accepts dates within the last twelve months." }, "dateTo": { "title": "Custom end date", "type": "string", "description": "YYYY-MM-DD. Ignored unless the custom start date is filled in too." }, "maxItems": { "title": "Maximum ads", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Total rows to return across every search. The budget is shared evenly, so four searches and 200 rows gives you fifty of each. Default 20, hard ceiling 2,000. Keep it low while testing - you pay per ad." }, "includeAdDetails": { "title": "Open each ad's detail page", "type": "boolean", "description": "On by default, and what you want. It is the only place LinkedIn publishes the untruncated ad copy, the landing URL, the run dates, the impressions band, the country split and the targeting. Switch it off for a fast advertiser/creative-only sweep; the price per ad is the same either way." }, "proxyUrls": { "title": "Your own proxy servers (optional)", "minItems": 0, "maxItems": 50, "type": "array", "description": "Leave this empty. By default the run rotates a large pool of addresses that cost you nothing per gigabyte. Fill it in only if you specifically want the traffic to leave through proxy servers you already pay for, in the form http://user:pass@host:port.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }