{
"openapi": "3.0.1",
"info": {
"title": "Pinterest Scraper — Pins, Boards, Profiles & Search",
"description": "Pinterest pins, boards and profiles from any search, board or profile: full-size image and video links, pinner, board, product price, creation date; optionally saves, repins, shares, comments, topics, followers, monthly views and every board. Export data to JSON, CSV or Excel, or via API.",
"version": "1.0",
"x-build-id": "10bUSI3gdJUkGUVc7"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~pinterest-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-pinterest-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/steadyscrape~pinterest-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-pinterest-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/steadyscrape~pinterest-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-pinterest-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": {
"searchQueries": {
"title": "Search Pinterest for",
"type": "array",
"description": "Words to search, one search per line, exactly as you would type them on Pinterest. Pinterest serves about 1,000 pins per search; for more, use narrower searches.",
"items": {
"type": "string"
}
},
"searchType": {
"title": "Search for",
"enum": [
"pins",
"videos"
],
"type": "string",
"description": "Pins is every kind of pin; Video pins only pins with a video. Applies to the words above; a search link keeps its own type.",
"default": "pins"
},
"urls": {
"title": "Pinterest links",
"type": "array",
"description": "Any of: a pin (pinterest.com/pin/317222367527146045/), a board (pinterest.com/marthastewart/canning-and-preserving/), a profile (pinterest.com/marthastewart/ or @marthastewart), a profile's own uploads (pinterest.com/marthastewart/_created/), a search (pinterest.com/search/pins/?q=cake) or a pin.it share link. Any country domain works.",
"items": {
"type": "string"
}
},
"maxPins": {
"title": "Max pins per search, board or profile",
"minimum": 0,
"type": "integer",
"description": "Checked before any request, so you never pay for more. 0 takes everything Pinterest lists: a whole board, a whole profile, or the ~1,000 pins of a search.",
"default": 100
},
"includeDetails": {
"title": "Read each pin's own page (saves, comments, mp4)",
"type": "boolean",
"description": "One extra request per pin for what only its page has: saves, repins, shares and comment count, the topics Pinterest links it to, the original creator and the video as an .mp4 file. Charged as pin-with-details instead of pin. A pin link always reads its page.",
"default": false
},
"includeProfile": {
"title": "Add a profile row per profile",
"type": "boolean",
"description": "For profile links: followers, following, pins, boards, monthly views, website and its verified domain, badges. Charged as one profile event.",
"default": true
},
"includeBoards": {
"title": "Add board rows",
"type": "boolean",
"description": "For a profile, one row per board it has (name, pins, followers, sections, cover, dates); for a board link, the board's own row. Charged as one board event each.",
"default": false
},
"profilePins": {
"title": "Pins of a profile link",
"enum": [
"all",
"created"
],
"type": "string",
"description": "All its pins is everything the account saved to its boards, newest first; Only its own uploads is the Created tab. A /_created/ link always means its own uploads.",
"default": "all"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}