{ "openapi": "3.0.1", "info": { "title": "Mastodon Scraper: Posts, Profiles, Followers & Trends", "description": "Scrape any Mastodon instance (mastodon.social, hachyderm.io, infosec.exchange, fosstodon.org and 11,000+ others) via the official REST API. User profiles, statuses, followers, hashtag timelines, status threads, trending tags. No auth, no proxies, no cookies. Pay only per result item.", "version": "0.1", "x-build-id": "bQyYgDBe3IAtWo8nG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/perconey~mastodon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-perconey-mastodon-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/perconey~mastodon-scraper/runs": { "post": { "operationId": "runs-sync-perconey-mastodon-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/perconey~mastodon-scraper/run-sync": { "post": { "operationId": "run-sync-perconey-mastodon-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": [ "action", "instance" ], "properties": { "action": { "title": "What do you want to scrape?", "enum": [ "getProfile", "getUserStatuses", "getUserFollowers", "getStatusDetail", "getStatusContext", "getHashtagTimeline", "getPublicTimeline", "getTrendingTags" ], "type": "string", "description": "Pick the type of data. getPublicTimeline and getTrendingTags work with no queries. The others require at least one entry in queries.", "default": "getProfile" }, "instance": { "title": "Mastodon instance", "type": "string", "description": "Which Mastodon-protocol server to query. Default https://mastodon.social. Examples: https://hachyderm.io, https://infosec.exchange, https://fosstodon.org. For getProfile with a full URL or acct (user@server), the actor uses that server automatically.", "default": "https://mastodon.social" }, "queries": { "title": "Queries", "type": "array", "description": "Depends on action. getProfile/getUserStatuses/getUserFollowers: handle (Gargron), acct (user@server), full profile URL (https://mastodon.social/@Gargron), or numeric id. getStatusDetail/getStatusContext: full status URL (https://mastodon.social/@user/123456...). getHashtagTimeline: hashtag without #. getPublicTimeline and getTrendingTags: leave empty.", "items": { "type": "string" } }, "maxItems": { "title": "Max items per query", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop after this many items per query. Use 0 for unlimited.", "default": 100 }, "local": { "title": "Local timeline only?", "type": "boolean", "description": "For getPublicTimeline and getHashtagTimeline: true returns only posts from the instance you query, false returns the federated firehose (posts from peers the instance has seen).", "default": true }, "onlyMedia": { "title": "Only posts with media", "type": "boolean", "description": "For timeline-style actions: skip text-only posts.", "default": false }, "includeReplies": { "title": "Include replies (getUserStatuses)", "type": "boolean", "description": "Set false to exclude posts that are replies to another user.", "default": true }, "includeReposts": { "title": "Include boosts/reposts (getUserStatuses)", "type": "boolean", "description": "Set false to exclude boosted (reblogged) posts.", "default": true }, "token": { "title": "Mastodon access token (optional)", "type": "string", "description": "OAuth bearer token for the instance. Only needed for actions that the instance restricts to logged-in users (some lock followers lists). Most public reads work without it." } } }, "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 } } }, "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 } } } } } } } } } }