{ "openapi": "3.0.1", "info": { "title": "Lemmy Scraper: Posts, Comments, Communities & Users", "description": "Scrape posts, comments, communities, search results and user profiles from any Lemmy instance in the fediverse, through the instance's own official API. No login or API key.", "version": "0.0", "x-build-id": "QU1gy6eFBz5WjmbRu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~lemmy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-lemmy-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/winterlock~lemmy-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-lemmy-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/winterlock~lemmy-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-lemmy-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": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "posts", "comments", "communities", "search", "user" ], "type": "string", "description": "Posts, comments, the community directory, a search, or user profiles.", "default": "posts" }, "instance": { "title": "Lemmy instance", "type": "string", "description": "Which server to read. Either lemmy.world or https://lemmy.world works. Try lemmy.ml, beehaw.org, sh.itjust.works or your own server.", "default": "lemmy.world" }, "communities": { "title": "Communities (optional)", "type": "array", "description": "Limit to specific communities. Use technology, !technology@lemmy.world, or a community link. Leave empty to read the whole instance.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "For Search. One query per line.", "items": { "type": "string" } }, "users": { "title": "Users", "type": "array", "description": "For Users. Use a username, user@instance, or a user link.", "items": { "type": "string" } }, "postId": { "title": "Post ID or link (optional)", "type": "string", "description": "For Comments. A post number like 53225445 or a link like https://lemmy.world/post/53225445 reads that one post's whole discussion instead of a community feed. A link is read from its own instance, because post numbers differ from server to server." }, "sort": { "title": "Sort order", "enum": [ "Active", "Hot", "New", "Old", "TopDay", "TopWeek", "TopMonth", "TopYear", "TopAll", "MostComments", "NewComments", "Controversial", "Scaled" ], "type": "string", "description": "Hot and Active are the live feeds. The Top options cover a fixed window.", "default": "Hot" }, "listingType": { "title": "Listing type", "enum": [ "All", "Local", "Subscribed" ], "type": "string", "description": "All includes federated content from other instances. Local is only what this server hosts.", "default": "All" }, "searchType": { "title": "Search for", "enum": [ "All", "Posts", "Comments", "Communities", "Users", "Url" ], "type": "string", "description": "Which kind of result a search returns.", "default": "Posts" }, "maxItemsPerTarget": { "title": "Max results per community, search or run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Lemmy pages 50 at a time.", "default": 50 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Lemmy instances are volunteer-run and rate-limit quickly. Keep this low to stay a good citizen.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs.", "default": { "useApifyProxy": 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 } } } } } } } } } }