{ "openapi": "3.0.1", "info": { "title": "Pinterest API Scraper", "description": "Scrape Pinterest pins, boards, users, search results, and private feeds via Pinterest's internal API. Supports 20+ actions including pin details, board scraping, user profiles, search, and more.", "version": "1.0", "x-build-id": "oxymrdVZHuYQHlax5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/imbuedata~pinterest-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-imbuedata-pinterest-api-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/imbuedata~pinterest-api-scraper/runs": { "post": { "operationId": "runs-sync-imbuedata-pinterest-api-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/imbuedata~pinterest-api-scraper/run-sync": { "post": { "operationId": "run-sync-imbuedata-pinterest-api-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", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "getPinInfo", "getPinDetails", "getRelatedPins", "searchPins", "getBoardDetails", "getBoardPins", "getBoardSections", "getBoardSectionById", "getBoardSectionBySlug", "getSectionPins", "getBoardRecommendations", "getBoardFeed", "getBoardSectionsRepin", "getUserBoards", "getUserPins", "getUserProfile", "getUserActivityPins", "getUserFollowing", "getUserFollowers", "getHomeFeed", "getBestPinsFeed", "getInterest", "getUserPrivateBoards", "getBoardPickerBoards" ], "type": "string", "description": "The Pinterest API action to perform." }, "pinUrl": { "title": "Pin URL", "type": "string", "description": "Full or short Pinterest pin URL (e.g. https://www.pinterest.com/pin/123456789/ or https://pin.it/abc). Used by: getPinInfo, getPinDetails, getRelatedPins." }, "pinId": { "title": "Pin ID", "type": "string", "description": "Pinterest pin ID (numeric). Alternative to pinUrl." }, "boardUrl": { "title": "Board URL", "type": "string", "description": "Full Pinterest board URL (e.g. https://www.pinterest.com/username/board-name/). Used by: getBoardDetails." }, "boardId": { "title": "Board ID", "type": "string", "description": "Pinterest board ID (numeric). Used by: getBoardPins, getBoardSections, getBoardSectionById, getBoardRecommendations, getBoardFeed, getBoardSectionsRepin." }, "sectionId": { "title": "Section ID", "type": "string", "description": "Pinterest board section ID. Used by: getBoardSectionById, getSectionPins." }, "username": { "title": "Username", "type": "string", "description": "Pinterest username (without @). Used by: getUserBoards, getUserPins, getUserProfile, getUserActivityPins, getUserFollowing, getBoardSectionBySlug, getUserPrivateBoards." }, "boardSlug": { "title": "Board Slug", "type": "string", "description": "Board URL slug (the part after username in the URL). Used by: getBoardSectionBySlug." }, "sectionSlug": { "title": "Section Slug", "type": "string", "description": "Section URL slug. Used by: getBoardSectionBySlug." }, "userId": { "title": "User ID", "type": "string", "description": "Pinterest user ID (numeric). Used by: getUserFollowers." }, "query": { "title": "Search Query", "type": "string", "description": "Search term. Used by: searchPins." }, "interest": { "title": "Interest", "type": "string", "description": "Pinterest interest/category slug. Used by: getBestPinsFeed, getInterest." }, "cookie": { "title": "Pinterest Cookie", "type": "string", "description": "Your Pinterest session cookie string. Required for private actions: getUserFollowing, getHomeFeed, getUserPrivateBoards, getBoardPickerBoards." }, "bookmark": { "title": "Bookmark (Pagination Cursor)", "type": "string", "description": "Pagination cursor from a previous run. Leave empty to start from the beginning." }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of items to collect. When set and the action supports pagination, the actor will auto-paginate until this limit is reached. Set to 0 for a single page only.", "default": 0 } } }, "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 } } } } } } } } } }