{
  "openapi": "3.0.1",
  "info": {
    "title": "Snapchat Spotlight Scraper",
    "description": "Scrape Snapchat Spotlight videos from the trending feed by country or from Spotlight URLs, with views, shares, boosts, recommends, comments, creator, sound, AI caption, hashtags and video download URL. No cookies needed.",
    "version": "1.5",
    "x-build-id": "jEVXzuB9XpU5kOymX"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/khadinakbar~snapchat-spotlight-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-khadinakbar-snapchat-spotlight-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/khadinakbar~snapchat-spotlight-scraper/runs": {
      "post": {
        "operationId": "runs-sync-khadinakbar-snapchat-spotlight-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/khadinakbar~snapchat-spotlight-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-khadinakbar-snapchat-spotlight-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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "trending",
              "urls",
              "username"
            ],
            "type": "string",
            "description": "Use this to choose what to scrape. \"trending\" pulls the live Spotlight feed for a country (no links needed). \"urls\" scrapes the exact Spotlight links you give and adds duration, size and top comments. \"username\" returns a creator's public Spotlight videos by handle, with sound and AI caption when Snapchat shows them. Defaults to \"trending\".",
            "default": "trending"
          },
          "spotlightUrls": {
            "title": "Spotlight URLs",
            "type": "array",
            "description": "Use this when mode is \"urls\". Accepts full Spotlight links such as https://www.snapchat.com/spotlight/W7_EDlXWTBiXAEEniNoMPwAAY... (one per line). Ignored in other modes. Not for profile links like snapchat.com/add/username; put those in Creator Usernames.",
            "items": {
              "type": "string"
            }
          },
          "usernames": {
            "title": "Creator Usernames",
            "type": "array",
            "description": "Use this when mode is \"username\". Accepts Snapchat handles or profile links such as mrbeast or https://www.snapchat.com/add/mrbeast (one per line). Returns up to about 10 recent public Spotlight videos per creator, as many as Snapchat shows on the profile. Ignored in other modes.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country (trending feed)",
            "type": "string",
            "description": "Use this to pick which country's trending feed to scrape. Accepts a two-letter code such as US, GB, IN, PK or SE (case-insensitive). Defaults to US. Non-US feeds use residential IPs in that country. Only applies when mode is \"trending\".",
            "default": "US"
          },
          "proxyType": {
            "title": "Proxy Type",
            "enum": [
              "auto",
              "residential",
              "datacenter"
            ],
            "type": "string",
            "description": "Use this to force a proxy. \"auto\" (default) fetches directly first and uses a residential proxy only if Snapchat blocks the request or a non-US feed is needed. \"residential\" always uses residential IPs and works for every country. \"datacenter\" uses datacenter IPs and works mainly for the US.",
            "default": "auto"
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Use this to cap how many videos are saved and billed. Accepts 1 to 1000; default 25. Snapchat shows about 20 videos per feed page, so large trending jobs fetch several pages with fresh IPs and remove duplicates; very large numbers can return fewer when the feed repeats itself.",
            "default": 25
          },
          "includeRawData": {
            "title": "Include Raw Data",
            "type": "boolean",
            "description": "Use this only when debugging Snapchat payload drift or building a custom parser. Accepts true or false; default is false to keep MCP output compact. Raw data attaches the full per-video metadata node and can be large. Not needed for normal exports.",
            "default": false
          },
          "includeTopComments": {
            "title": "Include top comments (urls mode)",
            "type": "boolean",
            "description": "Use this in \"urls\" mode to add up to 10 top public comments per video (text, author, date, likes). Accepts true or false; default true. No extra charge. Ignored in other modes.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}