{ "openapi": "3.0.1", "info": { "title": "Open5e D&D 5e SRD Scraper", "description": "Scrape the Open5e API - Dungeons & Dragons 5e SRD content. Fetch monsters, spells, magic items, races, classes, weapons and armor with full stats, descriptions and sourcebook attribution.", "version": "1.0", "x-build-id": "w7sdSlOYpRXXfOsqa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~open5e-dnd-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-open5e-dnd-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/crawlerbros~open5e-dnd-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-open5e-dnd-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/crawlerbros~open5e-dnd-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-open5e-dnd-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": [ "contentType" ], "properties": { "contentType": { "title": "Content type", "enum": [ "monsters", "spells", "magicItems", "races", "classes", "weapons", "armor" ], "type": "string", "description": "Which category of 5e content to fetch.", "default": "monsters" }, "search": { "title": "Search query", "type": "string", "description": "Free-text search across names and descriptions (e.g. `dragon`, `fireball`). Leave empty to browse the whole category.", "default": "dragon" }, "slugs": { "title": "Slugs (direct lookup)", "type": "array", "description": "Fetch specific entries by Open5e slug (e.g. `adult-red-dragon`, `fireball`). When set, other filters are ignored and each slug is fetched from the selected content type.", "default": [], "items": { "type": "string" } }, "monsterType": { "title": "Monster type (monsters)", "enum": [ "", "Aberration", "Beast", "Celestial", "Construct", "Dragon", "Elemental", "Fey", "Fiend", "Giant", "Humanoid", "Monstrosity", "Ooze", "Plant", "Swarm", "Undead" ], "type": "string", "description": "Filter monsters by creature type.", "default": "" }, "size": { "title": "Creature size (monsters)", "enum": [ "", "Tiny", "Small", "Medium", "Large", "Huge", "Gargantuan" ], "type": "string", "description": "Filter monsters by size.", "default": "" }, "crMin": { "title": "Min challenge rating (monsters)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Only include monsters with challenge rating >= this value." }, "crMax": { "title": "Max challenge rating (monsters)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Only include monsters with challenge rating <= this value." }, "spellLevel": { "title": "Spell level (spells)", "minimum": 0, "maximum": 9, "type": "integer", "description": "Filter spells by level (0 = cantrip, up to 9)." }, "school": { "title": "Spell school (spells)", "enum": [ "", "Abjuration", "Conjuration", "Divination", "Enchantment", "Evocation", "Illusion", "Necromancy", "Transmutation" ], "type": "string", "description": "Filter spells by school of magic.", "default": "" }, "dndClass": { "title": "Spellcasting class (spells)", "enum": [ "", "Bard", "Cleric", "Druid", "Paladin", "Ranger", "Sorcerer", "Warlock", "Wizard", "Artificer" ], "type": "string", "description": "Filter spells available to a class.", "default": "" }, "concentration": { "title": "Requires concentration (spells)", "type": "boolean", "description": "When enabled, only include spells that require concentration.", "default": false }, "spellRitual": { "title": "Ritual spells only (spells)", "type": "boolean", "description": "When enabled, only include spells that can be cast as a ritual.", "default": false }, "rarity": { "title": "Rarity (magic items)", "enum": [ "", "Common", "Uncommon", "Rare", "Very Rare", "Legendary", "Artifact" ], "type": "string", "description": "Filter magic items by rarity.", "default": "" }, "requiresAttunement": { "title": "Requires attunement (magic items)", "type": "boolean", "description": "When enabled, only include magic items that require attunement.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records. The scraper paginates until it reaches this many records or the category is exhausted.", "default": 25 } } }, "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 } } } } } } } } } }