{ "openapi": "3.0.1", "info": { "title": "TikTok Place / Location Scraper", "description": "Get public TikTok videos tagged at any place from place links, IDs, or place names. Or get place details with address, category, rating, photos, and optional reviews. Each video row has views, likes, creator, music, and GPS coordinates.", "version": "0.0", "x-build-id": "sl4ZZlSt7qrOjGM1r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~tiktok-location-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-tiktok-location-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/maximedupre~tiktok-location-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-tiktok-location-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/maximedupre~tiktok-location-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-tiktok-location-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": [ "resultType" ], "properties": { "placeUrls": { "title": "Place links or IDs", "type": "array", "description": "TikTok place links, such as https://www.tiktok.com/place/Eiffel-Tower-22535796485551493, or place IDs, such as 22535796485551493. Add one per line.", "items": { "type": "string", "minLength": 1 } }, "searchQueries": { "title": "Place names to search", "type": "array", "description": "Place names or keywords to search for on TikTok, such as a restaurant, a landmark, or a city. Add one per line.", "items": { "type": "string", "minLength": 1 } }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "The most rows to save in total. Leave empty or use 0 to get all available results." }, "resultType": { "title": "Result type", "enum": [ "videos", "places" ], "type": "string", "description": "Place videos saves one row for each video tagged at a place. Places saves one row for each place, with its details and, if you turn them on, its reviews." }, "maxVideosPerPlace": { "title": "Videos per place", "minimum": 0, "type": "integer", "description": "The most videos to get for each place. Leave empty or use 0 to get every video TikTok shows for the place." }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add public reviews to each place row: star rating, text, photos, author, like count, and date. Each review has its own charge.", "default": false }, "maxReviewsPerPlace": { "title": "Reviews per place", "minimum": 0, "type": "integer", "description": "Up to this many reviews for each place, where available. Use 0 to get every review. This works only when Include reviews is on.", "default": 20 }, "country": { "title": "Search country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code to search places in, such as US, FR, or JP. This applies only to place names to search. Leave empty to let TikTok choose." }, "maxPlacesPerQuery": { "title": "Places per name", "minimum": 1, "type": "integer", "description": "How many matching places to take for each place name to search, best match first. Use more than 1 for chains or common names.", "default": 1 }, "dealsOnly": { "title": "Only places with deals", "type": "boolean", "description": "Find only places that offer bookings or deals on TikTok. This applies only to place names to search.", "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 }, "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 } } } } } } } } } }