{ "openapi": "3.0.1", "info": { "title": "Naver Place Rank Tracker (네이버 플레이스 순위)", "description": "Enter Korean keywords like 강남 맛집 and your Naver Place IDs or links; get your place's rank in Naver Map search (up to rank 300) with rank change since the last run, optionally the full ranked list.", "version": "0.1", "x-build-id": "r4xjHaYr08893ftZn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magenta_courser~naver-place-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magenta_courser-naver-place-rank-tracker", "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/magenta_courser~naver-place-rank-tracker/runs": { "post": { "operationId": "runs-sync-magenta_courser-naver-place-rank-tracker", "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/magenta_courser~naver-place-rank-tracker/run-sync": { "post": { "operationId": "run-sync-magenta_courser-naver-place-rank-tracker", "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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Required. Naver Map search keywords, one per line, typed as a Korean customer would. Examples: 강남 맛집 (Gangnam restaurants), 성수 카페 (Seongsu cafes), 홍대 미용실 (Hongdae hair salons). A pasted map.naver.com search URL also works.", "items": { "type": "string" } }, "myPlaces": { "title": "My places (IDs or links)", "type": "array", "description": "Your places to track, one per line: the Naver place ID or a link to the place. Examples: 1501340733, https://map.naver.com/p/entry/place/1501340733, https://m.place.naver.com/restaurant/1501340733/home, https://naver.me/xxxxxxx. For each keyword you get one row (type = myPlaceRank) with the rank and the change since the last run. Leave empty to get only the ranked list.", "items": { "type": "string" } }, "myPlaceNames": { "title": "My place names (optional)", "type": "array", "description": "Optional. Match places by name when you do not know the ID, one per line, e.g. 생활생돈 or 스타벅스 강남역점. Spaces and letter case are ignored and a name also matches longer names that start with it (생활생돈 matches 생활생돈 선릉본점). The row shows the best-ranked match and nameMatches = how many places matched. IDs are more reliable: many businesses share a name.", "items": { "type": "string" } }, "maxRank": { "title": "Max rank", "minimum": 1, "maximum": 300, "type": "integer", "description": "How deep to scan each keyword: ranks 1 to maxRank, 50 per request. Default 50, maximum 300 (Naver Map lists about 300 places per keyword). You are charged per 50 ranks actually scanned, so maxRank 300 costs up to 6 times maxRank 50. Without the full list, a keyword stops as soon as all your places are found.", "default": 50 }, "searchLocation": { "title": "Search location (optional)", "type": "string", "description": "Optional. Where the customer is searching from, as \"latitude,longitude\", e.g. 37.4979,127.0276 (Gangnam Station). Naver ranks nearby places higher, so ranks can differ by location, especially for keywords without an area name (카페, 미용실). Leave empty to use Naver's default (no location sent). Rank history is kept separately per location." }, "includeTopList": { "title": "Include the full ranked list", "type": "boolean", "description": "Also output every ranked place (type = rankedPlace) up to maxRank with name, category, address, rating, review counts and rank change. Turned on automatically when no places are given.", "default": false }, "compareWithLastRun": { "title": "Compare with last run", "type": "boolean", "description": "Add previousRank, rankChange (positive = moved up) and isNewEntry, compared with the last completed run of the same keyword and location. The previous ranks are kept in a named key-value store in your account, so scheduled daily runs line up automatically.", "default": true }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Named key-value store that keeps the last ranks per keyword and location. Use a different name for each separate tracking project (for example one per client).", "default": "naver-place-rank-history" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Keep the default (Apify Proxy). Naver rate-limits repeated requests from one IP.", "default": { "useApifyProxy": 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 } } } } } } } } } }