{
"openapi": "3.0.1",
"info": {
"title": "Polarsteps Trip Scraper: Steps, Photos, GPS Track & GPX",
"description": "Export a full Polarsteps trip: every step with text, photos, videos and weather, the GPS track, routes with transport mode, the planned itinerary and comments. Public trips, private share links and whole profiles. GPX and GeoJSON files included.",
"version": "0.1",
"x-build-id": "t3ePe8tBcQvVXpkNq"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/alexmorain~polarsteps-trip-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-alexmorain-polarsteps-trip-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/alexmorain~polarsteps-trip-scraper/runs": {
"post": {
"operationId": "runs-sync-alexmorain-polarsteps-trip-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/alexmorain~polarsteps-trip-scraper/run-sync": {
"post": {
"operationId": "run-sync-alexmorain-polarsteps-trip-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": {
"tripUrls": {
"title": "Trip URLs",
"type": "array",
"description": "Polarsteps trip links or trip IDs. Accepted forms:
• https://www.polarsteps.com/<user>/<tripId>-<name>
• the share link of a private trip, ending with ?s=...
• the link of a single step (the whole trip is collected)
• a numeric trip ID such as 11306874",
"items": {
"type": "string"
}
},
"profiles": {
"title": "Profiles",
"type": "array",
"description": "Polarsteps usernames or profile links, such as takemeeverywhere or https://www.polarsteps.com/takemeeverywhere. Every public trip of each profile is collected, most recent first.",
"items": {
"type": "string"
}
},
"maxTripsPerProfile": {
"title": "Max trips per profile",
"minimum": 0,
"type": "integer",
"description": "Stop after this many trips for each profile, most recent first. 0 collects them all.",
"default": 0
},
"includeTrackPoints": {
"title": "Include GPS track points",
"type": "boolean",
"description": "Every point recorded by the Polarsteps tracker (time, coordinates, place), saved in the trip file trip-<id>.json. Often thousands of points per trip. The GPX and GeoJSON files keep the track either way.",
"default": true
},
"includeRouteSegments": {
"title": "Include route segments",
"type": "boolean",
"description": "The legs between steps with their transport mode (flight, car, train, motorbike...) and the decoded path, saved in the trip file.",
"default": true
},
"includePlannedSteps": {
"title": "Include planned itinerary",
"type": "boolean",
"description": "The planned stops of the trip, with planned date, nights and visit date, saved in the trip file.",
"default": true
},
"includeComments": {
"title": "Include step comments",
"type": "boolean",
"description": "Comments left on each step, with the author's username and name, in the step rows. Included in the step price. Polarsteps limits how fast comments can be read, so a trip with hundreds of commented steps takes several minutes.",
"default": false
},
"exportGpxGeojson": {
"title": "Export GPX and GeoJSON files",
"type": "boolean",
"description": "Saves trip-<id>.gpx and trip-<id>.geojson in the run's key-value store, ready for Google Earth, Komoot, Strava, QGIS or Mapbox. Links are in gpxUrl and geojsonUrl of every row.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed: Polarsteps answers without a proxy. Use it only if your runs get refused."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}