openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 121 kB
JSON
{"openapi":"3.0.1","servers":[{"description":"Production","url":"https://www.dnd5eapi.co"},{"description":"Local Development","url":"http://localhost:3000"}],"info":{"contact":{"name":"5eBits","url":"https://github.com/5e-bits"},"description":"# Introduction\n\nWelcome to the dnd5eapi, the Dungeons & Dragons 5th Edition API!\nThis documentation should help you familiarize yourself with the resources\navailable and how to consume them with HTTP requests. Read through the getting\nstarted section before you dive in. Most of your problems should be solved\njust by reading through it.\n\n## Getting Started\n\nLet's make our first API request to the D&D 5th Edition API!\n\nOpen up a terminal and use [curl](http://curl.haxx.se/) or [httpie](http://httpie.org/)\nto make an API request for a resource. You can also scroll through the\ndefinitions below and send requests directly from the endpoint documentation!\n\nFor example, if you paste and run this `curl` command:\n```bash\ncurl -X GET \"https://www.dnd5eapi.co/api/ability-scores/cha\" -H \"Accept: application/json\"\n```\n\nWe should see a result containing details about the Charisma ability score:\n```bash\n{\n \"index\": \"cha\",\n \"name\": \"CHA\",\n \"full_name\": \"Charisma\",\n \"desc\": [\n \"Charisma measures your ability to interact effectively with others. It\n includes such factors as confidence and eloquence, and it can represent\n a charming or commanding personality.\",\n \"A Charisma check might arise when you try to influence or entertain\n others, when you try to make an impression or tell a convincing lie,\n or when you are navigating a tricky social situation. The Deception,\n Intimidation, Performance, and Persuasion skills reflect aptitude in\n certain kinds of Charisma checks.\"\n ],\n \"skills\": [\n {\n \"name\": \"Deception\",\n \"index\": \"deception\",\n \"url\": \"/api/skills/deception\"\n },\n {\n \"name\": \"Intimidation\",\n \"index\": \"intimidation\",\n \"url\": \"/api/skills/intimidation\"\n },\n {\n \"name\": \"Performance\",\n \"index\": \"performance\",\n \"url\": \"/api/skills/performance\"\n },\n {\n \"name\": \"Persuasion\",\n \"index\": \"persuasion\",\n \"url\": \"/api/skills/persuasion\"\n }\n ],\n \"url\": \"/api/ability-scores/cha\"\n}\n```\n\n## Authentication\n\nThe dnd5eapi is a completely open API. No authentication is required to query\nand get data. This also means that we've limited what you can do to just\n`GET`-ing the data. If you find a mistake in the data, feel free to\n[message us](https://discord.gg/TQuYTv7).\n\n## GraphQL\n\nThis API supports [GraphQL](https://graphql.org/). The GraphQL URL for this API\nis `https://www.dnd5eapi.co/graphql`. Most of your questions regarding the GraphQL schema can be answered\nby querying the endpoint with the Apollo sandbox explorer.\n\n## Schemas\n\nDefinitions of all schemas will be accessible in a future update. Two of the most common schemas are described here.\n\n### `APIReference`\nRepresents a minimal representation of a resource. The detailed representation of the referenced resource can be retrieved by making a request to the referenced `URL`.\n```\nAPIReference {\n index string\n name string\n url string\n}\n```\n<hr>\n\n### `DC`\nRepresents a difficulty check.\n```\nDC {\n dc_type APIReference\n dc_value number\n success_type \"none\" | \"half\" | \"other\"\n}\n```\n<hr>\n\n### `Damage`\nRepresents damage.\n```\nDamage {\n damage_type APIReference\n damage_dice string\n}\n```\n<hr>\n\n### `Choice`\nRepresents a choice made by a player. Commonly seen related to decisions made during character creation or combat (e.g.: the description of the cleric class, under **Proficiencies**, states \"Skills: Choose two from\tHistory, Insight, Medicine, Persuasion, and\tReligion\" [[SRD p15]](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=15))\n```\nChoice {\n desc string\n choose number\n type string\n from OptionSet\n}\n```\n<hr>\n\n### `OptionSet`\nThe OptionSet structure provides the options to be chosen from, or sufficient data to fetch and interpret the options. All OptionSets have an `option_set_type` attribute that indicates the structure of the object that contains the options. The possible values are `options_array`, `equipment_category`, and `reference_list`. Other attributes on the OptionSet depend on the value of this attribute.\n- `options_array`\n - `options` (array): An array of Option objects. Each item in the array represents an option that can be chosen.\n- `equipment_category`\n - `equipment_category` (APIReference): A reference to an EquipmentCategory. Each item in the EquipmentCategory's `equipment` array represents one option that can be chosen.\n- `resource_list`\n - `resource_list_url` (string): A reference (by URL) to a collection in the database. The URL may include query parameters. Each item in the resulting ResourceList's `results` array represents one option that can be chosen.\n<hr>\n\n### `Option`\nWhen the options are given in an `options_array`, each item in the array inherits from the Option structure. All Options have an `option_type` attribute that indicates the structure of the option. The value of this attribute indicates how the option should be handled, and each type has different attributes. The possible values and their corresponding attributes are listed below.\n- `reference` - A terminal option. Contains a reference to a Document that can be added to the list of options chosen.\n - `item` (APIReference): A reference to the chosen item.\n- `action` - A terminal option. Contains information describing an action, for use within Multiattack actions.\n - `action_name` (string): The name of the action, according to its `name` attribute.\n - `count` (number | string): The number of times this action can be repeated if this option is chosen.\n - `type` (string = `\"melee\" | \"ranged\" | \"ability\" | \"magic\"`, optional): For attack actions that can be either melee, ranged, abilities, or magic.\n- `multiple` - When this option is chosen, all of its child options are chosen, and must be resolved the same way as a normal option.\n - `items` (array): An array of Option objects. All of them must be taken if the option is chosen.\n- `choice` - A nested choice. If this option is chosen, the Choice structure contained within must be resolved like a normal Choice structure, and the results are the chosen options.\n - `choice` (Choice): The Choice to resolve.\n- `string` - A terminal option. Contains a reference to a string.\n - `string` (string): The string.\n- `ideal` - A terminal option. Contains information about an ideal.\n - `desc` (string): A description of the ideal.\n - `alignments` (ApiReference[]): A list of alignments of those who might follow the ideal.\n- `counted_reference` - A terminal option. Contains a reference to something else in the API along with a count.\n - `count` (number): Count.\n - `of` (ApiReference): Thing being referenced.\n- `score_prerequisite` - A terminal option. Contains a reference to an ability score and a minimum score.\n - `ability_score` (ApiReference): Ability score being referenced.\n - `minimum_score` (number): The minimum score required to satisfy the prerequisite.\n- `ability_bonus` - A terminal option. Contains a reference to an ability score and a bonus\n - `ability_score` (ApiReference): Ability score being referenced\n - `bonus` (number): The bonus being applied to the ability score\n- `breath` - A terminal option: Contains a reference to information about a breath attack.\n - `name` (string): Name of the breath.\n - `dc` (DC): Difficulty check of the breath attack.\n - `damage` ([Damage]): Damage dealt by the breath attack, if any.\n- `damage` - A terminal option. Contains information about damage.\n - `damage_type` (ApiReference): Reference to type of damage.\n - `damage_dice` (string): Damage expressed in dice (e.g. \"13d6\").\n - `notes` (string): Information regarding the damage.\n\n## FAQ\n\n### What is the SRD?\nThe SRD, or Systems Reference Document, contains guidelines for publishing content under the OGL. This allows for some of the data for D&D 5e to be open source. The API only covers data that can be found in the SRD. [Here's a link to the full text of the SRD.](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf)\n\n### What is the OGL?\nThe Open Game License (OGL) is a public copyright license by Wizards of the Coast that may be used by tabletop role-playing game developers to grant permission to modify, copy, and redistribute some of the content designed for their games, notably game mechanics. However, they must share-alike copies and derivative works. [More information about the OGL can be found here.](https://en.wikipedia.org/wiki/Open_Game_License)\n\n### A monster, spell, subclass, etc. is missing from the API / Database. Can I add it?\nPlease check if the data is within the SRD. If it is, feel free to open an issue or PR to add it yourself. Otherwise, due to legal reasons, we cannot add it.\n\n### Can this API be self hosted?\nYes it can! You can also host the data yourself if you don't want to use the API at all. You can also make changes and add extra data if you like. However, it is up to you to merge in new changes to the data and API.\n\n#### Can I publish is on <insert platform>? Is this free use?\nYes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.\n\n# Status Page\n\nThe status page for the API can be found here: https://5e-bits.github.io/dnd-uptime/\n\n# Chat\n\nCome hang out with us [on Discord](https://discord.gg/TQuYTv7)!\n\n# Contribute\n\nThis API is built from two repositories.\n - The repo containing the data lives here: https://github.com/bagelbits/5e-database\n - The repo with the API implementation lives here: https://github.com/bagelbits/5e-srd-api\n\nThis is a evolving API and having fresh ideas are always welcome! You can\nopen an issue in either repo, open a PR for changes, or just discuss with\nother users in this discord.\n","license":{"name":"MIT License","url":"https://github.com/5e-bits/5e-srd-api/blob/main/LICENSE.md"},"title":"D&D 5e API","version":"0.1","x-apisguru-categories":["open_data"],"x-origin":[{"format":"openapi","url":"https://www.dnd5eapi.co/swagger/openapi.json","version":"3.0"}],"x-providerName":"dnd5eapi.co"},"tags":[{"name":"Common"},{"name":"Character Data"}],"paths":{"/api":{"get":{"description":"Making a request to the API's base URL returns an object containing available endpoints.","responses":{"200":{"content":{"application/json":{"example":{"ability-scores":"/api/ability-scores","alignments":"/api/alignments","backgrounds":"/api/backgrounds","classes":"/api/classes","conditions":"/api/conditions","damage-types":"/api/damage-types","equipment":"/api/equipment","equipment-categories":"/api/equipment-categories","feats":"/api/feats","features":"/api/features","languages":"/api/languages","magic-items":"/api/magic-items","magic-schools":"/api/magic-schools","monsters":"/api/monsters","proficiencies":"/api/proficiencies","races":"/api/races","rule-sections":"/api/rule-sections","rules":"/api/rules","skills":"/api/skills","spells":"/api/spells","subclasses":"/api/subclasses","subraces":"/api/subraces","traits":"/api/traits","weapon-properties":"/api/weapon-properties"},"schema":{"additionalProperties":{"type":"string"},"type":"object"}}},"description":"OK"}},"summary":"Get all resource URLs.","tags":["Common"]}},"/api/ability-scores/{index}":{"get":{"description":"# Ability Score\n\nRepresents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]\n","parameters":[{"$ref":"#/components/parameters/ability-score-index"}],"responses":{"200":{"content":{"application/json":{"example":{"desc":["Charisma measures your ability to interact effectively with others. It includes such factors as confidence and eloquence, and it can represent a charming or commanding personality.","A Charisma check might arise when you try to influence or entertain others, when you try to make an impression or tell a convincing lie, or when you are navigating a tricky social situation. The Deception, Intimidation, Performance, and Persuasion skills reflect aptitude in certain kinds of Charisma checks."],"full_name":"Charisma","index":"cha","name":"CHA","skills":[{"index":"deception","name":"Deception","url":"/api/skills/deception"},{"index":"intimidation","name":"Intimidation","url":"/api/skills/intimidation"},{"index":"performance","name":"Performance","url":"/api/skills/performance"},{"index":"persuasion","name":"Persuasion","url":"/api/skills/persuasion"}],"url":"/api/ability-scores/cha"},"schema":{"$ref":"#/components/schemas/AbilityScore"}}},"description":"OK"}},"summary":"Get an ability score by index.","tags":["Character Data"]}},"/api/alignments/{index}":{"get":{"description":"# Alignment\n\nA typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]\n","parameters":[{"$ref":"#/components/parameters/alignment-index"}],"responses":{"200":{"content":{"application/json":{"example":{"abbreviation":"CN","desc":"Chaotic neutral (CN) creatures follow their whims, holding their personal freedom above all else. Many barbarians and rogues, and some bards, are chaotic neutral.","index":"chaotic-neutral","name":"Chaotic Neutral","url":"/api/alignments/chaotic-neutral"},"schema":{"$ref":"#/components/schemas/Alignment"}}},"description":"OK"}},"summary":"Get an alignment by index.","tags":["Character Data"]}},"/api/backgrounds/{index}":{"get":{"description":"# Background\n\nEvery story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)]\n\n_Note:_ acolyte is the only background included in the SRD.\n","parameters":[{"$ref":"#/components/parameters/background-index"}],"responses":{"200":{"content":{"application/json":{"example":{"bonds":{"choose":1,"from":{"option_set_type":"options_array","options":[{"option_type":"string","string":"I would die to recover an ancient relic of my faith that was lost long ago."},{"option_type":"string","string":"I will someday get revenge on the corrupt temple hierarchy who branded me a heretic."},{"option_type":"string","string":"I owe my life to the priest who took me in when my parents died."},{"option_type":"string","string":"Everything I do is for the common people."},{"option_type":"string","string":"I will do anything to protect the temple where I served."},{"option_type":"string","string":"I seek to preserve a sacred text that my enemies consider heretical and seek to destroy."}]},"type":"bonds"},"feature":{"desc":["As an acolyte, you command the respect of those who share your faith, and you can perform the religious ceremonies of your deity. You and your adventuring companions can expect to receive free healing and care at a temple, shrine, or other established presence of your faith, though you must provide any material components needed for spells. Those who share your religion will support you (but only you) at a modest lifestyle.","You might also have ties to a specific temple dedicated to your chosen deity or pantheon, and you have a residence there. This could be the temple where you used to serve, if you remain on good terms with it, or a temple where you have found a new home. While near your temple, you can call upon the priests for assistance, provided the assistance you ask for is not hazardous and you remain in good standing with your temple."],"name":"Shelter of the Faithful"},"flaws":{"choose":1,"from":{"option_set_type":"options_array","options":[{"option_type":"string","string":"I judge others harshly, and myself even more severely."},{"option_type":"string","string":"I put too much trust in those who wield power within my temple's hierarchy."},{"option_type":"string","string":"My piety sometimes leads me to blindly trust those that profess faith in my god."},{"option_type":"string","string":"I am inflexible in my thinking."},{"option_type":"string","string":"I am suspicious of strangers and expect the worst of them."},{"option_type":"string","string":"Once I pick a goal, I become obsessed with it to the detriment of everything else in my life."}]},"type":"flaws"},"ideals":{"choose":1,"from":{"option_set_type":"options_array","options":[{"alignments":[{"index":"lawful-good","name":"Lawful Good","url":"/api/alignments/lawful-good"},{"index":"lawful-neutral","name":"Lawful Neutral","url":"/api/alignments/lawful-neutral"},{"index":"lawful-evil","name":"Lawful Evil","url":"/api/alignments/lawful-evil"}],"desc":"Tradition. The ancient traditions of worship and sacrifice must be preserved and upheld.","option_type":"ideal"},{"alignments":[{"index":"lawful-good","name":"Lawful Good","url":"/api/alignments/lawful-good"},{"index":"neutral-good","name":"Neutral Good","url":"/api/alignments/neutral-good"},{"index":"chaotic-good","name":"Chaotic Good","url":"/api/alignments/chaotic-good"}],"desc":"Charity. I always try to help those in need, no matter what the personal cost.","option_type":"ideal"},{"alignments":[{"index":"chaotic-good","name":"Chaotic Good","url":"/api/alignments/chaotic-good"},{"index":"chaotic-neutral","name":"Chaotic Neutral","url":"/api/alignments/chaotic-neutral"},{"index":"chaotic-evil","name":"Chaotic Evil","url":"/api/alignments/chaotic-evil"}],"desc":"Change. We must help bring about the changes the gods are constantly working in the world.","option_type":"ideal"},{"alignments":[{"index":"lawful-good","name":"Lawful Good","url":"/api/alignments/lawful-good"},{"index":"lawful-neutral","name":"Lawful Neutral","url":"/api/alignments/lawful-neutral"},{"index":"lawful-evil","name":"Lawful Evil","url":"/api/alignments/lawful-evil"}],"desc":"Power. I hope to one day rise to the top of my faith's religious hierarchy.","option_type":"ideal"},{"alignments":[{"index":"lawful-good","name":"Lawful Good","url":"/api/alignments/lawful-good"},{"index":"lawful-neutral","name":"Lawful Neutral","url":"/api/alignments/lawful-neutral"},{"index":"lawful-evil","name":"Lawful Evil","url":"/api/alignments/lawful-evil"}],"desc":"Faith. I trust that my deity will guide my actions. I have faith that if I work hard, things will go well.","option_type":"ideal"},{"alignments":[{"index":"lawful-good","name":"Lawful Good","url":"/api/alignments/lawful-good"},{"index":"neutral-good","name":"Neutral Good","url":"/api/alignments/neutral-good"},{"index":"chaotic-good","name":"Chaotic Good","url":"/api/alignments/chaotic-good"},{"index":"lawful-neutral","name":"Lawful Neutral","url":"/api/alignments/lawful-neutral"},{"index":"neutral","name":"Neutral","url":"/api/alignments/neutral"},{"index":"chaotic-neutral","name":"Chaotic Neutral","url":"/api/alignments/chaotic-neutral"},{"index":"lawful-evil","name":"Lawful Evil","url":"/api/alignments/lawful-evil"},{"index":"neutral-evil","name":"Neutral Evil","url":"/api/alignments/neutral-evil"},{"index":"chaotic-evil","name":"Chaotic Evil","url":"/api/alignments/chaotic-evil"}],"desc":"Aspiration. I seek to prove myself worthy of my god's favor by matching my actions against his or her teachings.","option_type":"ideal"}]},"type":"ideals"},"index":"acolyte","language_options":{"choose":2,"from":{"option_set_type":"resource_list","resource_list_url":"/api/languages"},"type":"languages"},"name":"Acolyte","personality_traits":{"choose":2,"from":{"option_set_type":"options_array","options":[{"option_type":"string","string":"I idolize a particular hero of my faith, and constantly refer to that person's deeds and example."},{"option_type":"string","string":"I can find common ground between the fiercest enemies, empathizing with them and always working toward peace."},{"option_type":"string","string":"I see omens in every event and action. The gods try to speak to us, we just need to listen."},{"option_type":"string","string":"Nothing can shake my optimistic attitude."},{"option_type":"string","string":"I quote (or misquote) sacred texts and proverbs in almost every situation."},{"option_type":"string","string":"I am tolerant (or intolerant) of other faiths and respect (or condemn) the worship of other gods."},{"option_type":"string","string":"I've enjoyed fine food, drink, and high society among my temple's elite. Rough living grates on me."},{"option_type":"string","string":"I've spent so long in the temple that I have little practical experience dealing with people in the outside world."}]},"type":"personality_traits"},"starting_equipment":[{"equipment":{"index":"clothes-common","name":"Clothes, common","url":"/api/equipment/clothes-common"},"quantity":1},{"equipment":{"index":"pouch","name":"Pouch","url":"/api/equipment/pouch"},"quantity":1}],"starting_equipment_options":[{"choose":1,"from":{"equipment_category":{"index":"holy-symbols","name":"Holy Symbols","url":"/api/equipment-categories/holy-symbols"},"option_set_type":"equipment_category"},"type":"equipment"}],"starting_proficiencies":[{"index":"skill-insight","name":"Skill: Insight","url":"/api/proficiencies/skill-insight"},{"index":"skill-religion","name":"Skill: Religion","url":"/api/proficiencies/skill-religion"}],"url":"/api/backgrounds/acolyte"},"schema":{"$ref":"#/components/schemas/Background"}}},"description":"OK"}},"summary":"Get a background by index.","tags":["Character Data"]}},"/api/classes/{index}":{"get":{"description":"# Class\n\nA character class is a fundamental part of the identity and nature of\ncharacters in the Dungeons & Dragons role-playing game. A character's\ncapabilities, strengths, and weaknesses are largely defined by its class.\nA character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]\n","parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"example":{"class_levels":"/api/classes/barbarian/levels","hit_die":12,"index":"barbarian","multi_classing":{"prerequisites":[{"ability_score":{"index":"str","name":"STR","url":"/api/ability-scores/str"},"minimum_score":13}],"proficiencies":[{"index":"shields","name":"Shields","url":"/api/proficiencies/shields"},{"index":"simple-weapons","name":"Simple Weapons","url":"/api/proficiencies/simple-weapons"},{"index":"martial-weapons","name":"Martial Weapons","url":"/api/proficiencies/martial-weapons"}],"proficiency_choices":[]},"name":"Barbarian","proficiencies":[{"index":"light-armor","name":"Light Armor","url":"/api/proficiencies/light-armor"},{"index":"medium-armor","name":"Medium Armor","url":"/api/proficiencies/medium-armor"},{"index":"shields","name":"Shields","url":"/api/proficiencies/shields"},{"index":"simple-weapons","name":"Simple Weapons","url":"/api/proficiencies/simple-weapons"},{"index":"martial-weapons","name":"Martial Weapons","url":"/api/proficiencies/martial-weapons"}],"proficiency_choices":[{"choose":2,"desc":"Choose two from Animal Handling, Athletics, Intimidation, Nature, Perception, and Survival","from":{"option_set_type":"options_array","options":[{"item":{"index":"skill-animal-handling","name":"Skill: Animal Handling","url":"/api/proficiencies/skill-animal-handling"},"option_type":"reference"},{"item":{"index":"skill-athletics","name":"Skill: Athletics","url":"/api/proficiencies/skill-athletics"},"option_type":"reference"},{"item":{"index":"skill-intimidation","name":"Skill: Intimidation","url":"/api/proficiencies/skill-intimidation"},"option_type":"reference"},{"item":{"index":"skill-nature","name":"Skill: Nature","url":"/api/proficiencies/skill-nature"},"option_type":"reference"},{"item":{"index":"skill-perception","name":"Skill: Perception","url":"/api/proficiencies/skill-perception"},"option_type":"reference"},{"item":{"index":"skill-survival","name":"Skill: Survival","url":"/api/proficiencies/skill-survival"},"option_type":"reference"}]},"type":"proficiencies"}],"saving_throws":[{"index":"str","name":"STR","url":"/api/ability-scores/str"},{"index":"con","name":"CON","url":"/api/ability-scores/con"}],"starting_equipment":[{"equipment":{"index":"explorers-pack","name":"Explorer's Pack","url":"/api/equipment/explorers-pack"},"quantity":1},{"equipment":{"index":"javelin","name":"Javelin","url":"/api/equipment/javelin"},"quantity":4}],"starting_equipment_options":[{"choose":1,"desc":"(a) a greataxe or (b) any martial melee weapon","from":{"option_set_type":"options_array","options":[{"count":1,"of":{"index":"greataxe","name":"Greataxe","url":"/api/equipment/greataxe"},"option_type":"counted_reference"},{"choice":{"choose":1,"desc":"any martial melee weapon","from":{"equipment_category":{"index":"martial-melee-weapons","name":"Martial Melee Weapons","url":"/api/equipment-categories/martial-melee-weapons"},"option_set_type":"equipment_category"},"type":"equipment"},"option_type":"choice"}]},"type":"equipment"},{"choose":1,"desc":"(a) two handaxes or (b) any simple weapon","from":{"option_set_type":"options_array","options":[{"count":2,"of":{"index":"handaxe","name":"Handaxe","url":"/api/equipment/handaxe"},"option_type":"counted_reference"},{"choice":{"choose":1,"desc":"any simple weapon","from":{"equipment_category":{"index":"simple-weapons","name":"Simple Weapons","url":"/api/equipment-categories/simple-weapons"},"option_set_type":"equipment_category"},"type":"equipment"},"option_type":"choice"}]},"type":"equipment"}],"subclasses":[{"index":"berserker","name":"Berserker","url":"/api/subclasses/berserker"}],"url":"/api/classes/barbarian"},"schema":{"$ref":"#/components/schemas/Class"}}},"description":"OK"}},"summary":"Get a class by index.","tags":["Class"]}},"/api/classes/{index}/features":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"List of features for the class."}},"summary":"Get features available for a class.","tags":["Class Resource Lists"]}},"/api/classes/{index}/levels":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"},{"$ref":"#/components/parameters/levels-subclass-filter"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClassLevel"},"type":"array"}}},"description":"OK"}},"summary":"Get all level resources for a class.","tags":["Class Levels"]}},"/api/classes/{index}/levels/{class_level}":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"},{"$ref":"#/components/parameters/class-level"}],"responses":{"200":{"content":{"application/json":{"example":{"ability_score_bonuses":0,"class":{"index":"barbarian","name":"Barbarian","url":"/api/classes/barbarian"},"class_specific":{"brutal_critical_dice":0,"rage_count":2,"rage_damage_bonus":2},"features":[{"index":"rage","name":"Rage","url":"/api/features/rage"},{"index":"barbarian-unarmored-defense","name":"Unarmored Defense","url":"/api/features/barbarian-unarmored-defense"}],"index":"barbarian-1","level":1,"prof_bonus":2,"url":"/api/classes/barbarian/levels/1"},"schema":{"$ref":"#/components/schemas/ClassLevel"}}},"description":"OK"}},"summary":"Get level resource for a class and level.","tags":["Class Levels"]}},"/api/classes/{index}/levels/{class_level}/features":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"},{"$ref":"#/components/parameters/class-level"}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"results":[{"index":"barbarian-unarmored-defense","name":"Unarmored Defense","url":"/api/features/barbarian-unarmored-defense"},{"index":"rage","name":"Rage","url":"/api/features/rage"}]},"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"OK"}},"summary":"Get features available to a class at the requested level.","tags":["Class Levels"]}},"/api/classes/{index}/levels/{spell_level}/spells":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"},{"$ref":"#/components/parameters/spell-level"}],"responses":{"200":{"content":{"application/json":{"example":{"count":5,"results":[{"index":"dominate-monster","name":"Dominate Monster","url":"/api/spells/dominate-monster"},{"index":"earthquake","name":"Earthquake","url":"/api/spells/earthquake"},{"index":"incendiary-cloud","name":"Incendiary Cloud","url":"/api/spells/incendiary-cloud"},{"index":"power-word-stun","name":"Power Word Stun","url":"/api/spells/power-word-stun"},{"index":"sunburst","name":"Sunburst","url":"/api/spells/sunburst"}]},"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"OK"}},"summary":"Get spells of the requested level available to the class.","tags":["Class Levels"]}},"/api/classes/{index}/multi-classing":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"example":{"prerequisites":[{"ability_score":{"index":"str","name":"STR","url":"/api/ability-scores/str"},"minimum_score":13}],"proficiencies":[{"index":"shields","name":"Shields","url":"/api/proficiencies/shields"},{"index":"simple-weapons","name":"Simple Weapons","url":"/api/proficiencies/simple-weapons"},{"index":"martial-weapons","name":"Martial Weapons","url":"/api/proficiencies/martial-weapons"}],"proficiency_choices":[]},"schema":{"$ref":"#/components/schemas/Multiclassing"}}},"description":"OK"}},"summary":"Get multiclassing resource for a class.","tags":["Class"]}},"/api/classes/{index}/proficiencies":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"List of proficiencies for the class."}},"summary":"Get proficiencies available for a class.","tags":["Class Resource Lists"]}},"/api/classes/{index}/spellcasting":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"example":{"info":[{"desc":["You know two cantrips of your choice from the bard spell list. You learn additional bard cantrips of your choice at higher levels, as shown in the Cantrips Known column of the Bard table."],"name":"Cantrips"},{"desc":["The Bard table shows how many spell slots you have to cast your spells of 1st level and higher. To cast one of these spells, you must expend a slot of the spell's level or higher. You regain all expended spell slots when you finish a long rest.","For example, if you know the 1st-level spell cure wounds and have a 1st-level and a 2nd-level spell slot available, you can cast cure wounds using either slot."],"name":"Spell Slots"},{"desc":["You know four 1st-level spells of your choice from the bard spell list.","The Spells Known column of the Bard table shows when you learn more bard spells of your choice.","Each of these spells must be of a level for which you have spell slots, as shown on the table. For instance, when you reach 3rd level in this class, you can learn one new spell of 1st or 2nd level.","Additionally, when you gain a level in this class, you can choose one of the bard spells you know and replace it with another spell from the bard spell list, which also must be of a level for which you have spell slots."],"name":"Spells Known of 1st Level and Higher"},{"desc":["Charisma is your spellcasting ability for your bard spells. Your magic comes from the heart and soul you pour into the performance of your music or oration. You use your Charisma whenever a spell refers to your spellcasting ability. In addition, you use your Charisma modifier when setting the saving throw DC for a bard spell you cast and when making an attack roll with one.","Spell save DC = 8 + your proficiency bonus + your Charisma modifier.","Spell attack modifier = your proficiency bonus + your Charisma modifier."],"name":"Spellcasting Ability"},{"desc":["You can cast any bard spell you know as a ritual if that spell has the ritual tag."],"name":"Ritual Casting"},{"desc":["You can use a musical instrument (see Equipment) as a spellcasting focus for your bard spells."],"name":"Spellcasting Focus"}],"level":1,"spellcasting_ability":{"index":"cha","name":"CHA","url":"/api/ability-scores/cha"}},"schema":{"$ref":"#/components/schemas/Spellcasting"}}},"description":"OK"},"404":{"content":{"application/json":{"example":{"error":"Not found"},"schema":{"$ref":"#/components/schemas/error-response"}}},"description":"Not found."}},"summary":"Get spellcasting info for a class.","tags":["Class"]}},"/api/classes/{index}/spells":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"example":{"count":2,"results":[{"index":"power-word-kill","name":"Power Word Kill","url":"/api/spells/power-word-kill"},{"index":"true-polymorph","name":"True Polymorph","url":"/api/spells/true-polymorph"}]},"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"OK"}},"summary":"Get spells available for a class.","tags":["Class Resource Lists"]}},"/api/classes/{index}/subclasses":{"get":{"parameters":[{"$ref":"#/components/parameters/class-index"}],"responses":{"200":{"content":{"application/json":{"example":{"count":1,"results":[{"index":"berserker","name":"Berserker","url":"/api/subclasses/berserker"}]},"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"OK"}},"summary":"Get subclasses available for a class.","tags":["Class Resource Lists"]}},"/api/conditions/{index}":{"get":{"description":"# Condition\n\nA condition alters a creature’s capabilities in a variety of ways and can \narise as a result of a spell, a class feature, a monster’s attack, or other \neffect. Most conditions, such as blinded, are impairments, but a few, such \nas invisible, can be advantageous.\n","parameters":[{"$ref":"#/components/parameters/condition-index"}],"responses":{"200":{"content":{"application/json":{"example":{"desc":["- A blinded creature can't see and automatically fails any ability check that requires sight.","- Attack rolls against the creature have advantage, and the creature's attack rolls have disadvantage."],"index":"blinded","name":"Blinded","url":"/api/conditions/blinded"},"schema":{"$ref":"#/components/schemas/Condition"}}},"description":"OK"}},"summary":"Get a condition by index.","tags":["Game Mechanics"]}},"/api/damage-types/{index}":{"get":{"description":"# Damage type\n\nDifferent attacks, damaging spells, and other harmful effects deal different \ntypes of damage. Damage types have no rules of their own, but other rules, \nsuch as damage resistance, rely on the types.\n","parameters":[{"$ref":"#/components/parameters/damage-type-index"}],"responses":{"200":{"content":{"application/json":{"example":{"desc":["The corrosive spray of a black dragon's breath and the dissolving enzymes secreted by a black pudding deal acid damage."],"index":"acid","name":"Acid","url":"/api/damage-types/acid"},"schema":{"$ref":"#/components/schemas/DamageType"}}},"description":"OK"}},"summary":"Get a damage type by index.","tags":["Game Mechanics"]}},"/api/equipment-categories/{index}":{"get":{"description":"These are the categories that various equipment fall under.","parameters":[{"description":"The `index` of the equipment category score to get.\n\nAvailable values can be found in the resource list for this endpoint.\n","example":"waterborne-vehicles","in":"path","name":"index","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"equipment":[{"index":"galley","name":"Galley","url":"/api/equipment/galley"},{"index":"keelboat","name":"Keelboat","url":"/api/equipment/keelboat"},{"index":"longship","name":"Longship","url":"/api/equipment/longship"},{"index":"rowboat","name":"Rowboat","url":"/api/equipment/rowboat"},{"index":"sailing-ship","name":"Sailing ship","url":"/api/equipment/sailing-ship"},{"index":"warship","name":"Warship","url":"/api/equipment/warship"}],"index":"waterborne-vehicles","name":"Waterborne Vehicles","url":"/api/equipment-categories/waterborne-vehicles"},"schema":{"$ref":"#/components/schemas/EquipmentCategory"}}},"description":"OK"}},"summary":"Get an equipment category by index.","tags":["Equipment"]}},"/api/equipment/{index}":{"get":{"description":"# Equipment\n\nOpportunities abound to find treasure, equipment, weapons, armor, and more \nin the dungeons you explore. Normally, you can sell your treasures and \ntrinkets when you return to a town or other settlement, provided that you \ncan find buyers and merchants interested in your loot.\n","parameters":[{"$ref":"#/components/parameters/equipment-index"}],"responses":{"200":{"content":{"application/json":{"example":{"category_range":"Simple Melee","contents":[],"cost":{"quantity":1,"unit":"sp"},"damage":{"damage_dice":"1d4","damage_type":{"index":"bludgeoning","name":"Bludgeoning","url":"/api/damage-types/bludgeoning"}},"desc":[],"equipment_category":{"index":"weapon","name":"Weapon","url":"/api/equipment-categories/weapon"},"index":"club","name":"Club","properties":[{"index":"light","name":"Light","url":"/api/weapon-properties/light"},{"index":"monk","name":"Monk","url":"/api/weapon-properties/monk"}],"range":{"long":null,"normal":5},"special":[],"url":"/api/equipment/club","weapon_category":"Simple","weapon_range":"Melee","weight":2},"schema":{"$ref":"#/components/schemas/Equipment"}}},"description":"OK"}},"summary":"Get an equipment item by index.","tags":["Equipment"]}},"/api/feats/{index}":{"get":{"description":"# Feat \n\nA feat is a boon a character can receive at level up instead of an ability score increase.\n","parameters":[{"description":"The `index` of the feat to get.\n","in":"path","name":"index","required":true,"schema":{"enum":["grappler"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"desc":["You’ve developed the Skills necessary to hold your own in close--quarters Grappling. You gain the following benefits:","- You have advantage on Attack Rolls against a creature you are Grappling.","- You can use your action to try to pin a creature Grappled by you. To do so, make another grapple check. If you succeed, you and the creature are both Restrained until the grapple ends."],"index":"grappler","name":"Grappler","prerequisites":[{"ability_score":{"index":"str","name":"STR","url":"/api/ability-scores/str"},"minimum_score":13}],"url":"/api/feats/grappler"},"schema":{"$ref":"#/components/schemas/Feat"}}},"description":"OK"}},"summary":"Get a feat by index.","tags":["Feats"]}},"/api/features/{index}":{"get":{"description":"# Feature \n\nWhen you gain a new level in a class, you get its features for that level. \nYou don’t, however, receive the class’s starting Equipment, and a few \nfeatures have additional rules when you’re multiclassing: Channel Divinity, \nExtra Attack, Unarmored Defense, and Spellcasting.\n","parameters":[{"$ref":"#/components/parameters/feature-index"}],"responses":{"200":{"content":{"application/json":{"example":{"class":{"index":"fighter","name":"Fighter","url":"/api/classes/fighter"},"desc":["Starting at 2nd level, you can push yourself beyond your normal limits for a moment. On your turn, you can take one additional action on top of your regular action and a possible bonus action.","Once you use this feature, you must finish a short or long rest before you can use it again. Starting at 17th level, you can use it twice before a rest, but only once on the same turn."],"index":"action-surge-1-use","level":2,"name":"Action Surge (1 use)","prerequisites":[],"url":"/api/features/action-surge-1-use"},"schema":{"$ref":"#/components/schemas/Feature"}}},"description":"OK"}},"summary":"Get a feature by index.","tags":["Features"]}},"/api/languages/{index}":{"get":{"description":"# Language\n\nYour race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]\n","parameters":[{"$ref":"#/components/parameters/language-index"}],"responses":{"200":{"content":{"application/json":{"example":{"desc":"Elvish is fluid, with subtle intonations and intricate grammar. Elven literature is rich and varied, and their songs and poems are famous among other races. Many bards learn their language so they can add Elvish ballads to their repertoires.","index":"elvish","name":"Elvish","script":"Elvish","type":"Standard","typical_speakers":["Elves"],"url":"/api/languages/elvish"},"schema":{"$ref":"#/components/schemas/Language"}}},"description":"OK"}},"summary":"Get a language by index.","tags":["Character Data"]}},"/api/magic-items/{index}":{"get":{"description":"These are the various magic items you can find in the game.","parameters":[{"description":"The `index` of the magic item to get.\n\nAvailable values can be found in the resource list for this endpoint.\n","example":"adamantine-armor","in":"path","name":"index","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"desc":["Armor (medium or heavy, but not hide), uncommon","This suit of armor is reinforced with adamantine, one of the hardest substances in existence. While you're wearing it, any critical hit against you becomes a normal hit."],"equipment_category":{"index":"armor","name":"Armor","url":"/api/equipment-categories/armor"},"index":"adamantine-armor","name":"Adamantine Armor","rarity":{"name":"Uncommon"},"url":"/api/magic-items/adamantine-armor","variant":false,"variants":[]},"schema":{"$ref":"#/components/schemas/MagicItem"}}},"description":"OK"}},"summary":"Get a magic item by index.","tags":["Equipment"]}},"/api/magic-schools/{index}":{"get":{"description":"# Magic School\n\nAcademies of magic group spells into eight categories called schools of \nmagic. Scholars, particularly wizards, apply these categories to all spells, \nbelieving that all magic functions in essentially the same way, whether it \nderives from rigorous study or is bestowed by a deity.\n","parameters":[{"$ref":"#/components/parameters/magic-school-index"}],"responses":{"200":{"content":{"application/json":{"example":{"desc":"Conjuration spells involve the transportation of objects and creatures from one location to another. Some spells summon creatures or objects to the caster's side, whereas others allow the caster to teleport to another location. Some conjurations create objects or effects out of nothing.","index":"conjuration","name":"Conjuration","url":"/api/magic-schools/conjuration"},"schema":{"$ref":"#/components/schemas/MagicSchool"}}},"description":"OK"}},"summary":"Get a magic school by index.","tags":["Game Mechanics"]}},"/api/monsters":{"get":{"parameters":[{"$ref":"#/components/parameters/challenge-rating-filter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIReferenceList"}}},"description":"OK"}},"summary":"Get list of monsters with optional filtering","tags":["Monsters"]}},"/api/monsters/{index}":{"get":{"parameters":[{"$ref":"#/components/parameters/monster-index"}],"responses":{"200":{"content":{"application/json":{"example":{"actions":[{"actions":[{"action_name":"Tentacle","count":3,"type":"melee"}],"attacks":[],"damage":[],"desc":"The aboleth makes three tentacle attacks.","multiattack_type":"actions","name":"Multiattack"},{"attack_bonus":9,"attacks":[],"damage":[{"damage_dice":"2d6+5","damage_type":{"index":"bludgeoning","name":"Bludgeoning","url":"/api/damage-types/bludgeoning"}},{"damage_dice":"1d12","damage_type":{"index":"acid","name":"Acid","url":"/api/damage-types/acid"}}],"dc":{"dc_type":{"index":"con","name":"CON","url":"/api/ability-scores/con"},"dc_value":14,"success_type":"none"},"desc":"Melee Weapon Attack: +9 to hit, reach 10 ft., one target. Hit: 12 (2d6 + 5) bludgeoning damage. If the target is a creature, it must succeed on a DC 14 Constitution saving throw or become diseased. The disease has no effect for 1 minute and can be removed by any magic that cures disease. After 1 minute, the diseased creature's skin becomes translucent and slimy, the creature can't regain hit points unless it is underwater, and the disease can be removed only by heal or another disease-curing spell of 6th level or higher. When the creature is outside a body of water, it takes 6 (1d12) acid damage every 10 minutes unless moisture is applied to the skin before 10 minutes have passed.","name":"Tentacle"},{"attack_bonus":9,"attacks":[],"damage":[{"damage_dice":"3d6+5","damage_type":{"index":"bludgeoning","name":"Bludgeoning","url":"/api/damage-types/bludgeoning"}}],"desc":"Melee Weapon Attack: +9 to hit, reach 10 ft. one target. Hit: 15 (3d6 + 5) bludgeoning damage.","name":"Tail"},{"attacks":[],"damage":[],"dc":{"dc_type":{"index":"wis","name":"WIS","url":"/api/ability-scores/wis"},"dc_value":14,"success_type":"none"},"desc":"The aboleth targets one creature it can see within 30 ft. of it. The target must succeed on a DC 14 Wisdom saving throw or be magically charmed by the aboleth until the aboleth dies or until it is on a different plane of existence from the target. The charmed target is under the aboleth's control and can't take reactions, and the aboleth and the target can communicate telepathically with each other over any distance.\nWhenever the charmed target takes damage, the target can repeat the saving throw. On a success, the effect ends. No more than once every 24 hours, the target can also repeat the saving throw when it is at least 1 mile away from the aboleth.","name":"Enslave","usage":{"times":3,"type":"per day"}}],"alignment":"lawful evil","armor_class":[{"type":"natural","value":17}],"challenge_rating":10,"charisma":18,"condition_immunities":[],"constitution":15,"damage_immunities":[],"damage_resistances":[],"damage_vulnerabilities":[],"dexterity":9,"forms":[],"hit_dice":"18d10","hit_points":135,"hit_points_roll":"18d10+36","index":"aboleth","intelligence":18,"languages":"Deep Speech, telepathy 120 ft.","legendary_actions":[{"damage":[],"desc":"The aboleth makes a Wisdom (Perception) check.","name":"Detect"},{"damage":[],"desc":"The aboleth makes one tail attack.","name":"Tail Swipe"},{"attack_bonus":0,"damage":[{"damage_dice":"3d6","damage_type":{"index":"psychic","name":"Psychic","url":"/api/damage-types/psychic"}}],"desc":"One creature charmed by the aboleth takes 10 (3d6) psychic damage, and the aboleth regains hit points equal to the damage the creature takes.","name":"Psychic Drain (Costs 2 Actions)"}],"name":"Aboleth","proficiencies":[{"proficiency":{"index":"saving-throw-con","name":"Saving Throw: CON","url":"/api/proficiencies/saving-throw-con"},"value":6},{"proficiency":{"index":"saving-throw-int","name":"Saving Throw: INT","url":"/api/proficiencies/saving-throw-int"},"value":8},{"proficiency":{"index":"saving-throw-wis","name":"Saving Throw: WIS","url":"/api/proficiencies/saving-throw-wis"},"value":6},{"proficiency":{"index":"skill-history","name":"Skill: History","url":"/api/proficiencies/skill-history"},"value":12},{"proficiency":{"index":"skill-perception","name":"Skill: Perception","url":"/api/proficiencies/skill-perception"},"value":10}],"reactions":[],"senses":{"darkvision":"120 ft.","passive_perception":20},"size":"Large","special_abilities":[{"damage":[],"desc":"The aboleth can breathe air and water.","name":"Amphibious"},{"damage":[],"dc":{"dc_type":{"index":"con","name":"CON","url":"/api/ability-scores/con"},"dc_value":14,"success_type":"none"},"desc":"While underwater, the aboleth is surrounded by transformative mucus. A creature that touches the aboleth or that hits it with a melee attack while within 5 ft. of it must make a DC 14 Constitution saving throw. On a failure, the creature is diseased for 1d4 hours. The diseased creature can breathe only underwater.","name":"Mucous Cloud"},{"damage":[],"desc":"If a creature communicates telepathically with the aboleth, the aboleth learns the creature's greatest desires if the aboleth can see the creature.","name":"Probing Telepathy"}],"speed":{"swim":"40 ft.","walk":"10 ft."},"strength":21,"subtype":null,"type":"aberration","url":"/api/monsters/aboleth","wisdom":15,"xp":5900},"schema":{"$ref":"#/components/schemas/Monster","allOf":{"3":{"properties":{"actions":{"items":{"properties":{"damage":{"items":{}}}}},"special_abilities":{"items":{"properties":{"usage":{}}}}}}}}}},"description":"OK"}},"summary":"Get monster by index.","tags":["Monsters"]}},"/api/proficiencies/{index}":{"get":{"description":"# Proficiency \n\nBy virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.\n","parameters":[{"$ref":"#/components/parameters/proficiency-index"}],"responses":{"200":{"con