{
  "openapi": "3.0.1",
  "info": {
    "title": "Pinterest Data Extractor",
    "description": "Scrape Pinterest pins, profiles, boards, search results, and comments. Extract images, videos, metadata, and engagement stats.",
    "version": "2.0",
    "x-build-id": "Dc0WxvkKuQnKu1evt"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlerbros~pinterest-data-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlerbros-pinterest-data-extractor",
        "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/crawlerbros~pinterest-data-extractor/runs": {
      "post": {
        "operationId": "runs-sync-crawlerbros-pinterest-data-extractor",
        "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/crawlerbros~pinterest-data-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-crawlerbros-pinterest-data-extractor",
        "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": {
          "mode": {
            "title": "What to collect",
            "enum": [
              "auto",
              "pinDetail",
              "comments",
              "searchPins",
              "searchVideos",
              "userProfile",
              "userPins",
              "userBoards",
              "boardDetail",
              "boardPins",
              "search"
            ],
            "type": "string",
            "description": "Choose a collection type. Auto-detect accepts mixed public Pinterest links.",
            "default": "auto"
          },
          "keywords": {
            "title": "Search words",
            "type": "array",
            "description": "One or more words or phrases for search modes.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "searchTerms": {
            "title": "Search words (compatibility alias)",
            "type": "array",
            "description": "Compatibility alias for Search words.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "pinUrls": {
            "title": "Pin URLs or IDs",
            "type": "array",
            "description": "Public Pin links or numeric Pin IDs. This is also accepted as `pinterestUrls` for compatibility.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "pinterestUrls": {
            "title": "Pin URLs or IDs (compatibility alias)",
            "type": "array",
            "description": "Compatibility alias for Pin URLs or IDs.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "usernames": {
            "title": "Pinterest usernames",
            "type": "array",
            "description": "Usernames, @usernames, or public profile links.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "profiles": {
            "title": "Profile names or links (compatibility alias)",
            "type": "array",
            "description": "Compatibility alias for Pinterest usernames.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "boardUrls": {
            "title": "Board URLs",
            "type": "array",
            "description": "Public board links or username/board-name paths.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "boards": {
            "title": "Board URLs (compatibility alias)",
            "type": "array",
            "description": "Compatibility alias for Board URLs.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "search": {
            "title": "Search Query",
            "type": "string",
            "description": "Keyword to search on Pinterest. Results will be pins matching this query."
          },
          "startUrls": {
            "title": "Pinterest URLs",
            "type": "array",
            "description": "List of Pinterest URLs to scrape. Supports pin URLs, user profile URLs, board URLs, and search URLs.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max Items",
            "minimum": 0,
            "maximum": 20000,
            "type": "integer",
            "description": "Maximum number of items to scrape. Set to 0 for unlimited.",
            "default": 50
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum pagination pages per search, profile, or board. 0 means continue until Pinterest has no next page.",
            "default": 0
          },
          "minSaves": {
            "title": "Minimum saves",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "0 means no minimum. For a positive value, keep only Pins where Pinterest supplies a numeric save count at or above it."
          },
          "minCreatorFollowers": {
            "title": "Minimum creator followers",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep Pins only when Pinterest supplies a creator follower count at or above this value."
          },
          "verifiedOnly": {
            "title": "Verified accounts only",
            "type": "boolean",
            "description": "Keep only rows explicitly marked verified by Pinterest.",
            "default": false
          },
          "requireOutboundLink": {
            "title": "Require destination link",
            "type": "boolean",
            "description": "Keep only Pins with a public destination link supplied by Pinterest.",
            "default": false
          },
          "imageOnly": {
            "title": "Images only",
            "type": "boolean",
            "description": "Exclude Pins that Pinterest identifies as video.",
            "default": false
          },
          "excludeAds": {
            "title": "Exclude promoted Pins",
            "type": "boolean",
            "description": "Exclude Pins Pinterest marks as promoted or sponsored.",
            "default": false
          },
          "commerceOnly": {
            "title": "Shoppable Pins only",
            "type": "boolean",
            "description": "Keep only Pins with source-backed product or shopping metadata.",
            "default": false
          },
          "includeComments": {
            "title": "Include Pin comments",
            "type": "boolean",
            "description": "When enabled, add one real comment/activity row for each collected Pin. Pinterest's public cookieless comment path is used automatically.",
            "default": false
          },
          "maxComments": {
            "title": "Maximum comments per Pin",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Maximum public comment/activity rows to add per Pin when comments are enabled.",
            "default": 10
          },
          "cookies": {
            "title": "Optional Pinterest cookies",
            "type": "array",
            "description": "Optional Cookie Editor JSON export. The actor works without cookies; never share this secret publicly."
          },
          "cookiesJson": {
            "title": "Optional cookies JSON (alias)",
            "type": "string",
            "description": "Compatibility alias for pasting a Cookie Editor JSON export."
          },
          "endPage": {
            "title": "End Page",
            "minimum": 0,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum number of pages to paginate through. Set to 0 for unlimited.",
            "default": 0
          },
          "enrichDetails": {
            "title": "Enrich Pin details",
            "type": "boolean",
            "description": "When enabled, collection Pins are checked on their public detail pages for creator names, follower counts, links, engagement, and media fields. Slower but more complete.",
            "default": false
          },
          "proxy": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Proxy settings for the scraper. Uses Apify Proxy by default."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration (alias)",
            "type": "object",
            "description": "Compatibility alias for proxy. Direct public Pin/profile pages also work without a proxy."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}