{
  "openapi": "3.0.1",
  "info": {
    "title": "Pinterest Trends Scraper & Keyword Research",
    "description": "Get Pinterest trending keywords by market and category, or research your own keywords with weekly history, related terms, audience and a forecast where available. No login.",
    "version": "0.1",
    "x-build-id": "ja8k991tmoHQtoTlf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automation-lab~pinterest-trends-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automation-lab-pinterest-trends-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/automation-lab~pinterest-trends-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automation-lab-pinterest-trends-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/automation-lab~pinterest-trends-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automation-lab-pinterest-trends-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": [
          "countries"
        ],
        "properties": {
          "countries": {
            "title": "Countries / regions",
            "type": "array",
            "description": "Pinterest Trends markets. Countries such as Switzerland are resolved to Pinterest's official regional market. Applies to both trend lists and keyword research.",
            "items": {
              "type": "string",
              "enum": [
                "US",
                "CA",
                "GB+IE",
                "DE",
                "FR",
                "IT",
                "ES",
                "MX",
                "BR",
                "AU+NZ",
                "AR",
                "CO",
                "IN",
                "ID",
                "MY",
                "PH",
                "TH",
                "SA",
                "EG",
                "TR",
                "KR",
                "AT",
                "CH",
                "PT",
                "GR",
                "MT",
                "SE",
                "DK",
                "FI",
                "NO",
                "NL",
                "BE",
                "LU",
                "PL",
                "RO",
                "HU",
                "SK",
                "CZ",
                "CL",
                "AE",
                "KW",
                "QA",
                "OM",
                "BH",
                "IQ",
                "DZ",
                "IL",
                "NG",
                "PK",
                "ZA",
                "MA",
                "CR",
                "DO",
                "EC",
                "GT",
                "PE",
                "CY"
              ],
              "enumTitles": [
                "United States",
                "Canada",
                "Great Britain & Ireland",
                "Germany",
                "France",
                "Italy",
                "Spain",
                "Mexico",
                "Brazil",
                "Australia & New Zealand",
                "Argentina",
                "Colombia",
                "India",
                "Indonesia",
                "Malaysia",
                "Philippines",
                "Thailand",
                "Saudi Arabia",
                "Egypt",
                "Turkey",
                "South Korea",
                "Austria (Germanics region)",
                "Switzerland (Germanics region)",
                "Portugal (Southern Europe region)",
                "Greece (Southern Europe region)",
                "Malta (Southern Europe region)",
                "Sweden (Nordics region)",
                "Denmark (Nordics region)",
                "Finland (Nordics region)",
                "Norway (Nordics region)",
                "Netherlands (Benelux region)",
                "Belgium (Benelux region)",
                "Luxembourg (Benelux region)",
                "Poland (Eastern Europe region)",
                "Romania (Eastern Europe region)",
                "Hungary (Eastern Europe region)",
                "Slovakia (Eastern Europe region)",
                "Czechia (Eastern Europe region)",
                "Chile (Hispanic LatAm region)",
                "United Arab Emirates (MENA region)",
                "Kuwait (MENA region)",
                "Qatar (MENA region)",
                "Oman (MENA region)",
                "Bahrain (MENA region)",
                "Iraq (MENA region)",
                "Algeria (MENA region)",
                "Israel (multi-regional market)",
                "Nigeria (multi-regional market)",
                "Pakistan (multi-regional market)",
                "South Africa (multi-regional market)",
                "Morocco (multi-regional market)",
                "Costa Rica (LatAm & Caribbean region)",
                "Dominican Republic (LatAm & Caribbean region)",
                "Ecuador (LatAm & Caribbean region)",
                "Guatemala (LatAm & Caribbean region)",
                "Peru (LatAm & Caribbean region)",
                "Cyprus (Eastern Europe & Mediterranean region)"
              ]
            },
            "default": [
              "US"
            ]
          },
          "trendTypes": {
            "title": "Trend types",
            "type": "array",
            "description": "Pinterest's trend lists. Clear this field to research only your keywords below. When left out via API it defaults to growing, unless keywords are given.",
            "items": {
              "type": "string",
              "enum": [
                "top_monthly",
                "top_yearly",
                "growing",
                "seasonal"
              ],
              "enumTitles": [
                "Top monthly trends",
                "Top yearly trends",
                "Growing trends",
                "Seasonal trends"
              ]
            }
          },
          "maxResultsPerCountry": {
            "title": "Max trends per country/type",
            "minimum": 1,
            "maximum": 250,
            "type": "integer",
            "description": "How many terms per market and list. Pinterest returns at most 100 per list, so higher values still return 100.",
            "default": 20
          },
          "keywords": {
            "title": "Keywords to research",
            "maxItems": 50,
            "type": "array",
            "description": "Your own keywords, up to 50 per run. Each keyword and market returns one row with weekly search history, week/month/year change, related keywords and audience by age and gender. Pinterest has no data for rare terms; those are skipped and not charged.",
            "items": {
              "type": "string"
            }
          },
          "historyDays": {
            "title": "Keyword history length",
            "enum": [
              "90",
              "180",
              "365",
              "730"
            ],
            "type": "string",
            "description": "How far back the weekly search history goes.",
            "default": "365"
          },
          "includeForecast": {
            "title": "Include forecast",
            "type": "boolean",
            "description": "Add Pinterest's 13-week forecast with its lower and upper bounds, when Pinterest has one for that keyword. US market only, and only from Pinterest's latest data date.",
            "default": true
          },
          "includeRelatedKeywords": {
            "title": "Include related keywords",
            "type": "boolean",
            "description": "Add the related keywords Pinterest shows for each keyword, with latest, peak and average search interest.",
            "default": true
          },
          "includeAudience": {
            "title": "Include audience",
            "type": "boolean",
            "description": "Add the share of searchers by age group and gender.",
            "default": true
          },
          "interests": {
            "title": "Categories",
            "type": "array",
            "description": "Limit trend lists to Pinterest's categories, such as Beauty or Home decor.",
            "items": {
              "type": "string",
              "enum": [
                "animals",
                "architecture",
                "art",
                "beauty",
                "design",
                "diy_and_crafts",
                "education",
                "electronics",
                "entertainment",
                "event_planning",
                "fashion",
                "finance",
                "food_and_drinks",
                "gardening",
                "health",
                "home_decor",
                "parenting",
                "quotes",
                "sport",
                "travel",
                "vehicles",
                "wedding"
              ],
              "enumTitles": [
                "Animals",
                "Architecture",
                "Art",
                "Beauty",
                "Design",
                "DIY and crafts",
                "Education",
                "Electronics",
                "Entertainment",
                "Event planning",
                "Fashion",
                "Finance",
                "Food and drinks",
                "Gardening",
                "Health",
                "Home decor",
                "Parenting",
                "Quotes",
                "Sport",
                "Travel",
                "Vehicles",
                "Wedding"
              ]
            }
          },
          "endDate": {
            "title": "End date",
            "type": "string",
            "description": "End date in YYYY-MM-DD format. Defaults to Pinterest's latest published data. Keyword research: a later date uses the latest data; dates up to one year back are accepted, or up to 28 days before the latest data with a 730-day history. An older date stops the run before any charge."
          },
          "lookbackWindow": {
            "title": "Lookback window",
            "enum": [
              "7D",
              "30D",
              "90D",
              "180D",
              "365D"
            ],
            "type": "string",
            "description": "Time window used for trend calculations.",
            "default": "30D"
          },
          "keywordsToInclude": {
            "title": "Keywords to include",
            "type": "array",
            "description": "Optional keyword filters. Example: nails, wedding, graduation.",
            "items": {
              "type": "string"
            }
          },
          "keywordsToExclude": {
            "title": "Keywords to exclude",
            "type": "array",
            "description": "Optional keywords to filter out.",
            "items": {
              "type": "string"
            }
          },
          "interestIds": {
            "title": "Pinterest interest IDs (advanced)",
            "type": "array",
            "description": "Pinterest's numeric category IDs. Category names such as beauty also work here, but the Categories field above is easier.",
            "items": {
              "type": "string"
            }
          },
          "rankingMethod": {
            "title": "Ranking method",
            "enum": [
              "TREND_RANK",
              "TOTAL_SEARCH",
              "WEEKLY_CHANGE",
              "MONTHLY_CHANGE",
              "YEARLY_CHANGE"
            ],
            "type": "string",
            "description": "Optional ranking metric for filtered trend lists."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}