{ "openapi": "3.0.1", "info": { "title": "Ultimate Pinterest Scraper & Intelligence API", "description": "All-in-one Pinterest scraper: search pins, videos, boards, users, niche analysis, trends, download media, and generate tags.", "version": "2.0", "x-build-id": "WreOaPcp2h0nVeevE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dev00~pinterest-ultimate-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dev00-pinterest-ultimate-api", "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-ultimate-api/runs": { "post": { "operationId": "runs-sync-dev00-pinterest-ultimate-api", "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-ultimate-api/run-sync": { "post": { "operationId": "run-sync-dev00-pinterest-ultimate-api", "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": [ "endpoint" ], "properties": { "endpoint": { "title": "API Endpoint Pathway", "enum": [ "pins/relevance", "pins/recent", "videos/relevance", "videos/recent", "boards/relevance", "users/relevance", "pin/info", "pin/comments", "pin/download", "pin/related", "pin/resolve", "pin/stats", "profile/info", "profile/boards", "profile/pins", "boards/pins", "trends/trending-now", "trends/growing", "trends/seasonal", "trends/monthly", "trends/yearly", "trends/categories", "trends/keyword", "trends/term-images", "keywords/generate", "tags/generate", "search/autocomplete", "niche/analyze", "email/check", "domain/sharing-count" ], "type": "string", "description": "Choose the target query endpoint you wish to run.", "default": "pins/relevance" }, "query": { "title": "Search Query / Base Term", "type": "string", "description": "Enter the search term, niche, autocomplete prefix, keyword seed, or hashtag topic." }, "pinId": { "title": "Pin ID", "type": "string", "description": "The target Pin ID (e.g. '1234567890'). Used in details, comments, downloads, related, stats." }, "username": { "title": "Username", "type": "string", "description": "Pinterest creator or brand username (e.g. 'nike'). Used in profile info, boards, pins." }, "boardId": { "title": "Board ID", "type": "string", "description": "Pinterest Board ID. Used in Board Pins lookup." }, "url": { "title": "Target URL", "type": "string", "description": "The pin.it short link to resolve, or domain name to check pin counts." }, "email": { "title": "Email Address", "type": "string", "description": "The email address to scan for existence." }, "terms": { "title": "Trend Terms (Comma-separated)", "type": "string", "description": "Only used for Term Images (e.g. 'shoes, outfits')." }, "count": { "title": "Result Limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Max number of items to retrieve (handles recursive internal pagination automatically).", "default": 25 }, "sort": { "title": "Board Pins Sorting", "enum": [ "default", "recent" ], "type": "string", "description": "Select sort index order.", "default": "default" }, "size": { "title": "Term Image Size Preset", "enum": [ "75x75", "170x", "236x", "474x", "564x", "736x", "originals" ], "type": "string", "description": "Select quality dimensions.", "default": "236x" }, "limit": { "title": "Images Limit Per Term", "minimum": 1, "maximum": 9, "type": "integer", "description": "Only used for Term Images (1 to 9).", "default": 2 }, "recursive": { "title": "Recursive Autocomplete Scan", "type": "boolean", "description": "Only used for Keywords Generation. Check to run deeper, recursive alphabet seed queries.", "default": false } } }, "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 } } } } } } } } } }