# openapi-client
# Introduction
Welcome to the dnd5eapi, the Dungeons & Dragons 5th Edition API!
This documentation should help you familiarize yourself with the resources
available and how to consume them with HTTP requests. Read through the getting
started section before you dive in. Most of your problems should be solved
just by reading through it.
## Getting Started
Let's make our first API request to the D&D 5th Edition API!
Open up a terminal and use [curl](http://curl.haxx.se/) or [httpie](http://httpie.org/)
to make an API request for a resource. You can also scroll through the
definitions below and send requests directly from the endpoint documentation!
For example, if you paste and run this `curl` command:
```bash
curl -X GET \"https://www.dnd5eapi.co/api/ability-scores/cha\" -H \"Accept: application/json\"
```
We should see a result containing details about the Charisma ability score:
```bash
{
\"index\": \"cha\",
\"name\": \"CHA\",
\"full_name\": \"Charisma\",
\"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.\"
],
\"skills\": [
{
\"name\": \"Deception\",
\"index\": \"deception\",
\"url\": \"/api/skills/deception\"
},
{
\"name\": \"Intimidation\",
\"index\": \"intimidation\",
\"url\": \"/api/skills/intimidation\"
},
{
\"name\": \"Performance\",
\"index\": \"performance\",
\"url\": \"/api/skills/performance\"
},
{
\"name\": \"Persuasion\",
\"index\": \"persuasion\",
\"url\": \"/api/skills/persuasion\"
}
],
\"url\": \"/api/ability-scores/cha\"
}
```
## Authentication
The dnd5eapi is a completely open API. No authentication is required to query
and get data. This also means that we've limited what you can do to just
`GET`-ing the data. If you find a mistake in the data, feel free to
[message us](https://discord.gg/TQuYTv7).
## GraphQL
This API supports [GraphQL](https://graphql.org/). The GraphQL URL for this API
is `https://www.dnd5eapi.co/graphql`. Most of your questions regarding the GraphQL schema can be answered
by querying the endpoint with the Apollo sandbox explorer.
## Schemas
Definitions of all schemas will be accessible in a future update. Two of the most common schemas are described here.
### `APIReference`
Represents a minimal representation of a resource. The detailed representation of the referenced resource can be retrieved by making a request to the referenced `URL`.
```
APIReference {
index string
name string
url string
}
```
<hr>
### `DC`
Represents a difficulty check.
```
DC {
dc_type APIReference
dc_value number
success_type \"none\" | \"half\" | \"other\"
}
```
<hr>
### `Damage`
Represents damage.
```
Damage {
damage_type APIReference
damage_dice string
}
```
<hr>
### `Choice`
Represents 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 History, Insight, Medicine, Persuasion, and Religion\" [[SRD p15]](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=15))
```
Choice {
desc string
choose number
type string
from OptionSet
}
```
<hr>
### `OptionSet`
The 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.
- `options_array`
- `options` (array): An array of Option objects. Each item in the array represents an option that can be chosen.
- `equipment_category`
- `equipment_category` (APIReference): A reference to an EquipmentCategory. Each item in the EquipmentCategory's `equipment` array represents one option that can be chosen.
- `resource_list`
- `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.
<hr>
### `Option`
When 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.
- `reference` - A terminal option. Contains a reference to a Document that can be added to the list of options chosen.
- `item` (APIReference): A reference to the chosen item.
- `action` - A terminal option. Contains information describing an action, for use within Multiattack actions.
- `action_name` (string): The name of the action, according to its `name` attribute.
- `count` (number | string): The number of times this action can be repeated if this option is chosen.
- `type` (string = `\"melee\" | \"ranged\" | \"ability\" | \"magic\"`, optional): For attack actions that can be either melee, ranged, abilities, or magic.
- `multiple` - When this option is chosen, all of its child options are chosen, and must be resolved the same way as a normal option.
- `items` (array): An array of Option objects. All of them must be taken if the option is chosen.
- `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.
- `choice` (Choice): The Choice to resolve.
- `string` - A terminal option. Contains a reference to a string.
- `string` (string): The string.
- `ideal` - A terminal option. Contains information about an ideal.
- `desc` (string): A description of the ideal.
- `alignments` (ApiReference[]): A list of alignments of those who might follow the ideal.
- `counted_reference` - A terminal option. Contains a reference to something else in the API along with a count.
- `count` (number): Count.
- `of` (ApiReference): Thing being referenced.
- `score_prerequisite` - A terminal option. Contains a reference to an ability score and a minimum score.
- `ability_score` (ApiReference): Ability score being referenced.
- `minimum_score` (number): The minimum score required to satisfy the prerequisite.
- `ability_bonus` - A terminal option. Contains a reference to an ability score and a bonus
- `ability_score` (ApiReference): Ability score being referenced
- `bonus` (number): The bonus being applied to the ability score
- `breath` - A terminal option: Contains a reference to information about a breath attack.
- `name` (string): Name of the breath.
- `dc` (DC): Difficulty check of the breath attack.
- `damage` ([Damage]): Damage dealt by the breath attack, if any.
- `damage` - A terminal option. Contains information about damage.
- `damage_type` (ApiReference): Reference to type of damage.
- `damage_dice` (string): Damage expressed in dice (e.g. \"13d6\").
- `notes` (string): Information regarding the damage.
## FAQ
### What is the SRD?
The 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)
### What is the OGL?
The 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)
### A monster, spell, subclass, etc. is missing from the API / Database. Can I add it?
Please 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.
### Can this API be self hosted?
Yes 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.
#### Can I publish is on <insert platform>? Is this free use?
Yes, 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.
# Status Page
The status page for the API can be found here: https://5e-bits.github.io/dnd-uptime/
# Chat
Come hang out with us [on Discord](https://discord.gg/TQuYTv7)!
# Contribute
This API is built from two repositories.
- The repo containing the data lives here: https://github.com/bagelbits/5e-database
- The repo with the API implementation lives here: https://github.com/bagelbits/5e-srd-api
This is a evolving API and having fresh ideas are always welcome! You can
open an issue in either repo, open a PR for changes, or just discuss with
other users in this discord.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/5e-bits](https://github.com/5e-bits)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import dnd5epy
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import dnd5epy
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import dnd5epy
from dnd5epy.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://www.dnd5eapi.co
# See configuration.py for a list of all supported configuration parameters.
configuration = dnd5epy.Configuration(
host = "https://www.dnd5eapi.co"
)
# Enter a context with an instance of the API client
with dnd5epy.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dnd5epy.CharacterDataApi(api_client)
index = 'cha' # str | The `index` of the ability score to get.
try:
# Get an ability score by index.
api_response = api_instance.api_ability_scores_index_get(index)
print("The response of CharacterDataApi->api_ability_scores_index_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CharacterDataApi->api_ability_scores_index_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://www.dnd5eapi.co*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CharacterDataApi* | [**api_ability_scores_index_get**](docs/CharacterDataApi.md#api_ability_scores_index_get) | **GET** /api/ability-scores/{index} | Get an ability score by index.
*CharacterDataApi* | [**api_alignments_index_get**](docs/CharacterDataApi.md#api_alignments_index_get) | **GET** /api/alignments/{index} | Get an alignment by index.
*CharacterDataApi* | [**api_backgrounds_index_get**](docs/CharacterDataApi.md#api_backgrounds_index_get) | **GET** /api/backgrounds/{index} | Get a background by index.
*CharacterDataApi* | [**api_languages_index_get**](docs/CharacterDataApi.md#api_languages_index_get) | **GET** /api/languages/{index} | Get a language by index.
*CharacterDataApi* | [**api_proficiencies_index_get**](docs/CharacterDataApi.md#api_proficiencies_index_get) | **GET** /api/proficiencies/{index} | Get a proficiency by index.
*CharacterDataApi* | [**api_skills_index_get**](docs/CharacterDataApi.md#api_skills_index_get) | **GET** /api/skills/{index} | Get a skill by index.
*ClassApi* | [**api_classes_index_get**](docs/ClassApi.md#api_classes_index_get) | **GET** /api/classes/{index} | Get a class by index.
*ClassApi* | [**api_classes_index_multi_classing_get**](docs/ClassApi.md#api_classes_index_multi_classing_get) | **GET** /api/classes/{index}/multi-classing | Get multiclassing resource for a class.
*ClassApi* | [**api_classes_index_spellcasting_get**](docs/ClassApi.md#api_classes_index_spellcasting_get) | **GET** /api/classes/{index}/spellcasting | Get spellcasting info for a class.
*ClassLevelsApi* | [**api_classes_index_levels_class_level_features_get**](docs/ClassLevelsApi.md#api_classes_index_levels_class_level_features_get) | **GET** /api/classes/{index}/levels/{class_level}/features | Get features available to a class at the requested level.
*ClassLevelsApi* | [**api_classes_index_levels_class_level_get**](docs/ClassLevelsApi.md#api_classes_index_levels_class_level_get) | **GET** /api/classes/{index}/levels/{class_level} | Get level resource for a class and level.
*ClassLevelsApi* | [**api_classes_index_levels_get**](docs/ClassLevelsApi.md#api_classes_index_levels_get) | **GET** /api/classes/{index}/levels | Get all level resources for a class.
*ClassLevelsApi* | [**api_classes_index_levels_spell_level_spells_get**](docs/ClassLevelsApi.md#api_classes_index_levels_spell_level_spells_get) | **GET** /api/classes/{index}/levels/{spell_level}/spells | Get spells of the requested level available to the class.
*ClassResourceListsApi* | [**api_classes_index_features_get**](docs/ClassResourceListsApi.md#api_classes_index_features_get) | **GET** /api/classes/{index}/features | Get features available for a class.
*ClassResourceListsApi* | [**api_classes_index_proficiencies_get**](docs/ClassResourceListsApi.md#api_classes_index_proficiencies_get) | **GET** /api/classes/{index}/proficiencies | Get proficiencies available for a class.
*ClassResourceListsApi* | [**api_classes_index_spells_get**](docs/ClassResourceListsApi.md#api_classes_index_spells_get) | **GET** /api/classes/{index}/spells | Get spells available for a class.
*ClassResourceListsApi* | [**api_classes_index_subclasses_get**](docs/ClassResourceListsApi.md#api_classes_index_subclasses_get) | **GET** /api/classes/{index}/subclasses | Get subclasses available for a class.
*CommonApi* | [**api_endpoint_get**](docs/CommonApi.md#api_endpoint_get) | **GET** /api/{endpoint} | Get list of all available resources for an endpoint.
*CommonApi* | [**api_get**](docs/CommonApi.md#api_get) | **GET** /api | Get all resource URLs.
*EquipmentApi* | [**api_equipment_categories_index_get**](docs/EquipmentApi.md#api_equipment_categories_index_get) | **GET** /api/equipment-categories/{index} | Get an equipment category by index.
*EquipmentApi* | [**api_equipment_index_get**](docs/EquipmentApi.md#api_equipment_index_get) | **GET** /api/equipment/{index} | Get an equipment item by index.
*EquipmentApi* | [**api_magic_items_index_get**](docs/EquipmentApi.md#api_magic_items_index_get) | **GET** /api/magic-items/{index} | Get a magic item by index.
*EquipmentApi* | [**api_weapon_properties_index_get**](docs/EquipmentApi.md#api_weapon_properties_index_get) | **GET** /api/weapon-properties/{index} | Get a weapon property by index.
*FeatsApi* | [**api_feats_index_get**](docs/FeatsApi.md#api_feats_index_get) | **GET** /api/feats/{index} | Get a feat by index.
*FeaturesApi* | [**api_features_index_get**](docs/FeaturesApi.md#api_features_index_get) | **GET** /api/features/{index} | Get a feature by index.
*GameMechanicsApi* | [**api_conditions_index_get**](docs/GameMechanicsApi.md#api_conditions_index_get) | **GET** /api/conditions/{index} | Get a condition by index.
*GameMechanicsApi* | [**api_damage_types_index_get**](docs/GameMechanicsApi.md#api_damage_types_index_get) | **GET** /api/damage-types/{index} | Get a damage type by index.
*GameMechanicsApi* | [**api_magic_schools_index_get**](docs/GameMechanicsApi.md#api_magic_schools_index_get) | **GET** /api/magic-schools/{index} | Get a magic school by index.
*MonstersApi* | [**api_monsters_get**](docs/MonstersApi.md#api_monsters_get) | **GET** /api/monsters | Get list of monsters with optional filtering
*MonstersApi* | [**api_monsters_index_get**](docs/MonstersApi.md#api_monsters_index_get) | **GET** /api/monsters/{index} | Get monster by index.
*RacesApi* | [**api_races_index_get**](docs/RacesApi.md#api_races_index_get) | **GET** /api/races/{index} | Get a race by index.
*RacesApi* | [**api_races_index_proficiencies_get**](docs/RacesApi.md#api_races_index_proficiencies_get) | **GET** /api/races/{index}/proficiencies | Get proficiencies available for a race.
*RacesApi* | [**api_races_index_subraces_get**](docs/RacesApi.md#api_races_index_subraces_get) | **GET** /api/races/{index}/subraces | Get subraces available for a race.
*RacesApi* | [**api_races_index_traits_get**](docs/RacesApi.md#api_races_index_traits_get) | **GET** /api/races/{index}/traits | Get traits available for a race.
*RulesApi* | [**api_rule_sections_index_get**](docs/RulesApi.md#api_rule_sections_index_get) | **GET** /api/rule-sections/{index} | Get a rule section by index.
*RulesApi* | [**api_rules_index_get**](docs/RulesApi.md#api_rules_index_get) | **GET** /api/rules/{index} | Get a rule by index.
*SpellsApi* | [**api_spells_get**](docs/SpellsApi.md#api_spells_get) | **GET** /api/spells | Get list of spells with optional filtering.
*SpellsApi* | [**api_spells_index_get**](docs/SpellsApi.md#api_spells_index_get) | **GET** /api/spells/{index} | Get a spell by index.
*SubclassesApi* | [**api_subclasses_index_features_get**](docs/SubclassesApi.md#api_subclasses_index_features_get) | **GET** /api/subclasses/{index}/features | Get features available for a subclass.
*SubclassesApi* | [**api_subclasses_index_get**](docs/SubclassesApi.md#api_subclasses_index_get) | **GET** /api/subclasses/{index} | Get a subclass by index.
*SubclassesApi* | [**api_subclasses_index_levels_get**](docs/SubclassesApi.md#api_subclasses_index_levels_get) | **GET** /api/subclasses/{index}/levels | Get all level resources for a subclass.
*SubclassesApi* | [**api_subclasses_index_levels_subclass_level_features_get**](docs/SubclassesApi.md#api_subclasses_index_levels_subclass_level_features_get) | **GET** /api/subclasses/{index}/levels/{subclass_level}/features | Get features of the requested spell level available to the class.
*SubclassesApi* | [**api_subclasses_index_levels_subclass_level_get**](docs/SubclassesApi.md#api_subclasses_index_levels_subclass_level_get) | **GET** /api/subclasses/{index}/levels/{subclass_level} | Get level resources for a subclass and level.
*SubracesApi* | [**api_subraces_index_get**](docs/SubracesApi.md#api_subraces_index_get) | **GET** /api/subraces/{index} | Get a subrace by index.
*SubracesApi* | [**api_subraces_index_proficiencies_get**](docs/SubracesApi.md#api_subraces_index_proficiencies_get) | **GET** /api/subraces/{index}/proficiencies | Get proficiences available for a subrace.
*SubracesApi* | [**api_subraces_index_traits_get**](docs/SubracesApi.md#api_subraces_index_traits_get) | **GET** /api/subraces/{index}/traits | Get traits available for a subrace.
*TraitsApi* | [**api_traits_index_get**](docs/TraitsApi.md#api_traits_index_get) | **GET** /api/traits/{index} | Get a trait by index.
## Documentation For Models
- [APIReference](docs/APIReference.md)
- [APIReferenceList](docs/APIReferenceList.md)
- [AbilityBonus](docs/AbilityBonus.md)
- [AbilityScore](docs/AbilityScore.md)
- [Alignment](docs/Alignment.md)
- [AreaOfEffect](docs/AreaOfEffect.md)
- [Armor](docs/Armor.md)
- [Background](docs/Background.md)
- [BackgroundAllOfFeature](docs/BackgroundAllOfFeature.md)
- [Choice](docs/Choice.md)
- [ClassAllOfStartingEquipment](docs/ClassAllOfStartingEquipment.md)
- [ClassLevel](docs/ClassLevel.md)
- [ClassLevelClassSpecific](docs/ClassLevelClassSpecific.md)
- [ClassLevelClassSpecificAnyOf](docs/ClassLevelClassSpecificAnyOf.md)
- [ClassLevelClassSpecificAnyOf1](docs/ClassLevelClassSpecificAnyOf1.md)
- [ClassLevelClassSpecificAnyOf10](docs/ClassLevelClassSpecificAnyOf10.md)
- [ClassLevelClassSpecificAnyOf11](docs/ClassLevelClassSpecificAnyOf11.md)
- [ClassLevelClassSpecificAnyOf2](docs/ClassLevelClassSpecificAnyOf2.md)
- [ClassLevelClassSpecificAnyOf3](docs/ClassLevelClassSpecificAnyOf3.md)
- [ClassLevelClassSpecificAnyOf4](docs/ClassLevelClassSpecificAnyOf4.md)
- [ClassLevelClassSpecificAnyOf5](docs/ClassLevelClassSpecificAnyOf5.md)
- [ClassLevelClassSpecificAnyOf5MartialArts](docs/ClassLevelClassSpecificAnyOf5MartialArts.md)
- [ClassLevelClassSpecificAnyOf6](docs/ClassLevelClassSpecificAnyOf6.md)
- [ClassLevelClassSpecificAnyOf7](docs/ClassLevelClassSpecificAnyOf7.md)
- [ClassLevelClassSpecificAnyOf8](docs/ClassLevelClassSpecificAnyOf8.md)
- [ClassLevelClassSpecificAnyOf9](docs/ClassLevelClassSpecificAnyOf9.md)
- [ClassLevelClassSpecificAnyOf9CreatingSpellSlotsInner](docs/ClassLevelClassSpecificAnyOf9CreatingSpellSlotsInner.md)
- [Condition](docs/Condition.md)
- [Cost](docs/Cost.md)
- [DC](docs/DC.md)
- [Damage](docs/Damage.md)
- [DamageAtCharacterLevel](docs/DamageAtCharacterLevel.md)
- [DamageAtSlotLevel](docs/DamageAtSlotLevel.md)
- [DamageType](docs/DamageType.md)
- [Equipment](docs/Equipment.md)
- [EquipmentCategory](docs/EquipmentCategory.md)
- [EquipmentPack](docs/EquipmentPack.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [Feat](docs/Feat.md)
- [Feature](docs/Feature.md)
- [FeatureAllOfPrerequisitesInner](docs/FeatureAllOfPrerequisitesInner.md)
- [FeatureAllOfPrerequisitesInnerAnyOf](docs/FeatureAllOfPrerequisitesInnerAnyOf.md)
- [FeatureAllOfPrerequisitesInnerAnyOf1](docs/FeatureAllOfPrerequisitesInnerAnyOf1.md)
- [FeatureAllOfPrerequisitesInnerAnyOf2](docs/FeatureAllOfPrerequisitesInnerAnyOf2.md)
- [Gear](docs/Gear.md)
- [Language](docs/Language.md)
- [MagicItem](docs/MagicItem.md)
- [MagicItemAllOfRarity](docs/MagicItemAllOfRarity.md)
- [MagicSchool](docs/MagicSchool.md)
- [ModelClass](docs/ModelClass.md)
- [Monster](docs/Monster.md)
- [MonsterAbility](docs/MonsterAbility.md)
- [MonsterAction](docs/MonsterAction.md)
- [MonsterAllOfSenses](docs/MonsterAllOfSenses.md)
- [MonsterAllOfSpeed](docs/MonsterAllOfSpeed.md)
- [MonsterArmorClass](docs/MonsterArmorClass.md)
- [MonsterArmorClassOneOf](docs/MonsterArmorClassOneOf.md)
- [MonsterArmorClassOneOf1](docs/MonsterArmorClassOneOf1.md)
- [MonsterArmorClassOneOf2](docs/MonsterArmorClassOneOf2.md)
- [MonsterArmorClassOneOf3](docs/MonsterArmorClassOneOf3.md)
- [MonsterArmorClassOneOf4](docs/MonsterArmorClassOneOf4.md)
- [MonsterAttack](docs/MonsterAttack.md)
- [MonsterMultiAttackAction](docs/MonsterMultiAttackAction.md)
- [MonsterProficiency](docs/MonsterProficiency.md)
- [MonsterSense](docs/MonsterSense.md)
- [MonsterSpecialAbility](docs/MonsterSpecialAbility.md)
- [MonsterSpell](docs/MonsterSpell.md)
- [MonsterSpellcasting](docs/MonsterSpellcasting.md)
- [MonsterUsage](docs/MonsterUsage.md)
- [Multiclassing](docs/Multiclassing.md)
- [Option](docs/Option.md)
- [OptionOneOf](docs/OptionOneOf.md)
- [OptionOneOf1](docs/OptionOneOf1.md)
- [OptionOneOf10](docs/OptionOneOf10.md)
- [OptionOneOf2](docs/OptionOneOf2.md)
- [OptionOneOf3](docs/OptionOneOf3.md)
- [OptionOneOf4](docs/OptionOneOf4.md)
- [OptionOneOf5](docs/OptionOneOf5.md)
- [OptionOneOf6](docs/OptionOneOf6.md)
- [OptionOneOf7](docs/OptionOneOf7.md)
- [OptionOneOf8](docs/OptionOneOf8.md)
- [OptionOneOf9](docs/OptionOneOf9.md)
- [OptionSet](docs/OptionSet.md)
- [OptionSetOneOf](docs/OptionSetOneOf.md)
- [OptionSetOneOf1](docs/OptionSetOneOf1.md)
- [OptionSetOneOf2](docs/OptionSetOneOf2.md)
- [Prerequisite](docs/Prerequisite.md)
- [PrerequisiteAbilityScore](docs/PrerequisiteAbilityScore.md)
- [Proficiency](docs/Proficiency.md)
- [ProficiencyAllOfReference](docs/ProficiencyAllOfReference.md)
- [Race](docs/Race.md)
- [ResourceDescription](docs/ResourceDescription.md)
- [Rule](docs/Rule.md)
- [RuleSection](docs/RuleSection.md)
- [Skill](docs/Skill.md)
- [Spell](docs/Spell.md)
- [SpellAllOfDamage](docs/SpellAllOfDamage.md)
- [SpellPrerequisite](docs/SpellPrerequisite.md)
- [Spellcasting](docs/Spellcasting.md)
- [SpellcastingInfoInner](docs/SpellcastingInfoInner.md)
- [SpellcastingSpellcastingAbility](docs/SpellcastingSpellcastingAbility.md)
- [Subclass](docs/Subclass.md)
- [SubclassAllOfSpells](docs/SubclassAllOfSpells.md)
- [SubclassLevel](docs/SubclassLevel.md)
- [SubclassLevelResource](docs/SubclassLevelResource.md)
- [SubclassLevelSpellcasting](docs/SubclassLevelSpellcasting.md)
- [Subrace](docs/Subrace.md)
- [SubraceAllOfRace](docs/SubraceAllOfRace.md)
- [Trait](docs/Trait.md)
- [TraitAllOfTraitSpecific](docs/TraitAllOfTraitSpecific.md)
- [TraitAllOfTraitSpecificOneOf](docs/TraitAllOfTraitSpecificOneOf.md)
- [TraitAllOfTraitSpecificOneOfBreathWeapon](docs/TraitAllOfTraitSpecificOneOfBreathWeapon.md)
- [TraitAllOfTraitSpecificOneOfBreathWeaponDamage](docs/TraitAllOfTraitSpecificOneOfBreathWeaponDamage.md)
- [TraitAllOfTraitSpecificOneOfBreathWeaponUsage](docs/TraitAllOfTraitSpecificOneOfBreathWeaponUsage.md)
- [TraitAllOfTraitSpecificOneOfDamageType](docs/TraitAllOfTraitSpecificOneOfDamageType.md)
- [Weapon](docs/Weapon.md)
- [WeaponAllOfRange](docs/WeaponAllOfRange.md)
- [WeaponProperty](docs/WeaponProperty.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "dnd5epy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,D&D 5e API",
"author": "5eBits",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/c0/70/00f0b4b1d0fb3dc7c0a476a3d7bb3d6268e5322c020680e5092045626707/dnd5epy-1.0.7.tar.gz",
"platform": null,
"description": "# openapi-client\n# 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 History, Insight, Medicine, Persuasion, and Religion\\\" [[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\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://github.com/5e-bits](https://github.com/5e-bits)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport dnd5epy\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport dnd5epy\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport dnd5epy\nfrom dnd5epy.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://www.dnd5eapi.co\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = dnd5epy.Configuration(\n host = \"https://www.dnd5eapi.co\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith dnd5epy.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = dnd5epy.CharacterDataApi(api_client)\n index = 'cha' # str | The `index` of the ability score to get. \n\n try:\n # Get an ability score by index.\n api_response = api_instance.api_ability_scores_index_get(index)\n print(\"The response of CharacterDataApi->api_ability_scores_index_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling CharacterDataApi->api_ability_scores_index_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://www.dnd5eapi.co*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CharacterDataApi* | [**api_ability_scores_index_get**](docs/CharacterDataApi.md#api_ability_scores_index_get) | **GET** /api/ability-scores/{index} | Get an ability score by index.\n*CharacterDataApi* | [**api_alignments_index_get**](docs/CharacterDataApi.md#api_alignments_index_get) | **GET** /api/alignments/{index} | Get an alignment by index.\n*CharacterDataApi* | [**api_backgrounds_index_get**](docs/CharacterDataApi.md#api_backgrounds_index_get) | **GET** /api/backgrounds/{index} | Get a background by index.\n*CharacterDataApi* | [**api_languages_index_get**](docs/CharacterDataApi.md#api_languages_index_get) | **GET** /api/languages/{index} | Get a language by index.\n*CharacterDataApi* | [**api_proficiencies_index_get**](docs/CharacterDataApi.md#api_proficiencies_index_get) | **GET** /api/proficiencies/{index} | Get a proficiency by index.\n*CharacterDataApi* | [**api_skills_index_get**](docs/CharacterDataApi.md#api_skills_index_get) | **GET** /api/skills/{index} | Get a skill by index.\n*ClassApi* | [**api_classes_index_get**](docs/ClassApi.md#api_classes_index_get) | **GET** /api/classes/{index} | Get a class by index.\n*ClassApi* | [**api_classes_index_multi_classing_get**](docs/ClassApi.md#api_classes_index_multi_classing_get) | **GET** /api/classes/{index}/multi-classing | Get multiclassing resource for a class.\n*ClassApi* | [**api_classes_index_spellcasting_get**](docs/ClassApi.md#api_classes_index_spellcasting_get) | **GET** /api/classes/{index}/spellcasting | Get spellcasting info for a class.\n*ClassLevelsApi* | [**api_classes_index_levels_class_level_features_get**](docs/ClassLevelsApi.md#api_classes_index_levels_class_level_features_get) | **GET** /api/classes/{index}/levels/{class_level}/features | Get features available to a class at the requested level.\n*ClassLevelsApi* | [**api_classes_index_levels_class_level_get**](docs/ClassLevelsApi.md#api_classes_index_levels_class_level_get) | **GET** /api/classes/{index}/levels/{class_level} | Get level resource for a class and level.\n*ClassLevelsApi* | [**api_classes_index_levels_get**](docs/ClassLevelsApi.md#api_classes_index_levels_get) | **GET** /api/classes/{index}/levels | Get all level resources for a class.\n*ClassLevelsApi* | [**api_classes_index_levels_spell_level_spells_get**](docs/ClassLevelsApi.md#api_classes_index_levels_spell_level_spells_get) | **GET** /api/classes/{index}/levels/{spell_level}/spells | Get spells of the requested level available to the class.\n*ClassResourceListsApi* | [**api_classes_index_features_get**](docs/ClassResourceListsApi.md#api_classes_index_features_get) | **GET** /api/classes/{index}/features | Get features available for a class.\n*ClassResourceListsApi* | [**api_classes_index_proficiencies_get**](docs/ClassResourceListsApi.md#api_classes_index_proficiencies_get) | **GET** /api/classes/{index}/proficiencies | Get proficiencies available for a class.\n*ClassResourceListsApi* | [**api_classes_index_spells_get**](docs/ClassResourceListsApi.md#api_classes_index_spells_get) | **GET** /api/classes/{index}/spells | Get spells available for a class.\n*ClassResourceListsApi* | [**api_classes_index_subclasses_get**](docs/ClassResourceListsApi.md#api_classes_index_subclasses_get) | **GET** /api/classes/{index}/subclasses | Get subclasses available for a class.\n*CommonApi* | [**api_endpoint_get**](docs/CommonApi.md#api_endpoint_get) | **GET** /api/{endpoint} | Get list of all available resources for an endpoint.\n*CommonApi* | [**api_get**](docs/CommonApi.md#api_get) | **GET** /api | Get all resource URLs.\n*EquipmentApi* | [**api_equipment_categories_index_get**](docs/EquipmentApi.md#api_equipment_categories_index_get) | **GET** /api/equipment-categories/{index} | Get an equipment category by index.\n*EquipmentApi* | [**api_equipment_index_get**](docs/EquipmentApi.md#api_equipment_index_get) | **GET** /api/equipment/{index} | Get an equipment item by index.\n*EquipmentApi* | [**api_magic_items_index_get**](docs/EquipmentApi.md#api_magic_items_index_get) | **GET** /api/magic-items/{index} | Get a magic item by index.\n*EquipmentApi* | [**api_weapon_properties_index_get**](docs/EquipmentApi.md#api_weapon_properties_index_get) | **GET** /api/weapon-properties/{index} | Get a weapon property by index.\n*FeatsApi* | [**api_feats_index_get**](docs/FeatsApi.md#api_feats_index_get) | **GET** /api/feats/{index} | Get a feat by index.\n*FeaturesApi* | [**api_features_index_get**](docs/FeaturesApi.md#api_features_index_get) | **GET** /api/features/{index} | Get a feature by index.\n*GameMechanicsApi* | [**api_conditions_index_get**](docs/GameMechanicsApi.md#api_conditions_index_get) | **GET** /api/conditions/{index} | Get a condition by index.\n*GameMechanicsApi* | [**api_damage_types_index_get**](docs/GameMechanicsApi.md#api_damage_types_index_get) | **GET** /api/damage-types/{index} | Get a damage type by index.\n*GameMechanicsApi* | [**api_magic_schools_index_get**](docs/GameMechanicsApi.md#api_magic_schools_index_get) | **GET** /api/magic-schools/{index} | Get a magic school by index.\n*MonstersApi* | [**api_monsters_get**](docs/MonstersApi.md#api_monsters_get) | **GET** /api/monsters | Get list of monsters with optional filtering\n*MonstersApi* | [**api_monsters_index_get**](docs/MonstersApi.md#api_monsters_index_get) | **GET** /api/monsters/{index} | Get monster by index.\n*RacesApi* | [**api_races_index_get**](docs/RacesApi.md#api_races_index_get) | **GET** /api/races/{index} | Get a race by index.\n*RacesApi* | [**api_races_index_proficiencies_get**](docs/RacesApi.md#api_races_index_proficiencies_get) | **GET** /api/races/{index}/proficiencies | Get proficiencies available for a race.\n*RacesApi* | [**api_races_index_subraces_get**](docs/RacesApi.md#api_races_index_subraces_get) | **GET** /api/races/{index}/subraces | Get subraces available for a race.\n*RacesApi* | [**api_races_index_traits_get**](docs/RacesApi.md#api_races_index_traits_get) | **GET** /api/races/{index}/traits | Get traits available for a race.\n*RulesApi* | [**api_rule_sections_index_get**](docs/RulesApi.md#api_rule_sections_index_get) | **GET** /api/rule-sections/{index} | Get a rule section by index.\n*RulesApi* | [**api_rules_index_get**](docs/RulesApi.md#api_rules_index_get) | **GET** /api/rules/{index} | Get a rule by index.\n*SpellsApi* | [**api_spells_get**](docs/SpellsApi.md#api_spells_get) | **GET** /api/spells | Get list of spells with optional filtering.\n*SpellsApi* | [**api_spells_index_get**](docs/SpellsApi.md#api_spells_index_get) | **GET** /api/spells/{index} | Get a spell by index.\n*SubclassesApi* | [**api_subclasses_index_features_get**](docs/SubclassesApi.md#api_subclasses_index_features_get) | **GET** /api/subclasses/{index}/features | Get features available for a subclass.\n*SubclassesApi* | [**api_subclasses_index_get**](docs/SubclassesApi.md#api_subclasses_index_get) | **GET** /api/subclasses/{index} | Get a subclass by index.\n*SubclassesApi* | [**api_subclasses_index_levels_get**](docs/SubclassesApi.md#api_subclasses_index_levels_get) | **GET** /api/subclasses/{index}/levels | Get all level resources for a subclass.\n*SubclassesApi* | [**api_subclasses_index_levels_subclass_level_features_get**](docs/SubclassesApi.md#api_subclasses_index_levels_subclass_level_features_get) | **GET** /api/subclasses/{index}/levels/{subclass_level}/features | Get features of the requested spell level available to the class.\n*SubclassesApi* | [**api_subclasses_index_levels_subclass_level_get**](docs/SubclassesApi.md#api_subclasses_index_levels_subclass_level_get) | **GET** /api/subclasses/{index}/levels/{subclass_level} | Get level resources for a subclass and level.\n*SubracesApi* | [**api_subraces_index_get**](docs/SubracesApi.md#api_subraces_index_get) | **GET** /api/subraces/{index} | Get a subrace by index.\n*SubracesApi* | [**api_subraces_index_proficiencies_get**](docs/SubracesApi.md#api_subraces_index_proficiencies_get) | **GET** /api/subraces/{index}/proficiencies | Get proficiences available for a subrace.\n*SubracesApi* | [**api_subraces_index_traits_get**](docs/SubracesApi.md#api_subraces_index_traits_get) | **GET** /api/subraces/{index}/traits | Get traits available for a subrace.\n*TraitsApi* | [**api_traits_index_get**](docs/TraitsApi.md#api_traits_index_get) | **GET** /api/traits/{index} | Get a trait by index.\n\n\n## Documentation For Models\n\n - [APIReference](docs/APIReference.md)\n - [APIReferenceList](docs/APIReferenceList.md)\n - [AbilityBonus](docs/AbilityBonus.md)\n - [AbilityScore](docs/AbilityScore.md)\n - [Alignment](docs/Alignment.md)\n - [AreaOfEffect](docs/AreaOfEffect.md)\n - [Armor](docs/Armor.md)\n - [Background](docs/Background.md)\n - [BackgroundAllOfFeature](docs/BackgroundAllOfFeature.md)\n - [Choice](docs/Choice.md)\n - [ClassAllOfStartingEquipment](docs/ClassAllOfStartingEquipment.md)\n - [ClassLevel](docs/ClassLevel.md)\n - [ClassLevelClassSpecific](docs/ClassLevelClassSpecific.md)\n - [ClassLevelClassSpecificAnyOf](docs/ClassLevelClassSpecificAnyOf.md)\n - [ClassLevelClassSpecificAnyOf1](docs/ClassLevelClassSpecificAnyOf1.md)\n - [ClassLevelClassSpecificAnyOf10](docs/ClassLevelClassSpecificAnyOf10.md)\n - [ClassLevelClassSpecificAnyOf11](docs/ClassLevelClassSpecificAnyOf11.md)\n - [ClassLevelClassSpecificAnyOf2](docs/ClassLevelClassSpecificAnyOf2.md)\n - [ClassLevelClassSpecificAnyOf3](docs/ClassLevelClassSpecificAnyOf3.md)\n - [ClassLevelClassSpecificAnyOf4](docs/ClassLevelClassSpecificAnyOf4.md)\n - [ClassLevelClassSpecificAnyOf5](docs/ClassLevelClassSpecificAnyOf5.md)\n - [ClassLevelClassSpecificAnyOf5MartialArts](docs/ClassLevelClassSpecificAnyOf5MartialArts.md)\n - [ClassLevelClassSpecificAnyOf6](docs/ClassLevelClassSpecificAnyOf6.md)\n - [ClassLevelClassSpecificAnyOf7](docs/ClassLevelClassSpecificAnyOf7.md)\n - [ClassLevelClassSpecificAnyOf8](docs/ClassLevelClassSpecificAnyOf8.md)\n - [ClassLevelClassSpecificAnyOf9](docs/ClassLevelClassSpecificAnyOf9.md)\n - [ClassLevelClassSpecificAnyOf9CreatingSpellSlotsInner](docs/ClassLevelClassSpecificAnyOf9CreatingSpellSlotsInner.md)\n - [Condition](docs/Condition.md)\n - [Cost](docs/Cost.md)\n - [DC](docs/DC.md)\n - [Damage](docs/Damage.md)\n - [DamageAtCharacterLevel](docs/DamageAtCharacterLevel.md)\n - [DamageAtSlotLevel](docs/DamageAtSlotLevel.md)\n - [DamageType](docs/DamageType.md)\n - [Equipment](docs/Equipment.md)\n - [EquipmentCategory](docs/EquipmentCategory.md)\n - [EquipmentPack](docs/EquipmentPack.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [Feat](docs/Feat.md)\n - [Feature](docs/Feature.md)\n - [FeatureAllOfPrerequisitesInner](docs/FeatureAllOfPrerequisitesInner.md)\n - [FeatureAllOfPrerequisitesInnerAnyOf](docs/FeatureAllOfPrerequisitesInnerAnyOf.md)\n - [FeatureAllOfPrerequisitesInnerAnyOf1](docs/FeatureAllOfPrerequisitesInnerAnyOf1.md)\n - [FeatureAllOfPrerequisitesInnerAnyOf2](docs/FeatureAllOfPrerequisitesInnerAnyOf2.md)\n - [Gear](docs/Gear.md)\n - [Language](docs/Language.md)\n - [MagicItem](docs/MagicItem.md)\n - [MagicItemAllOfRarity](docs/MagicItemAllOfRarity.md)\n - [MagicSchool](docs/MagicSchool.md)\n - [ModelClass](docs/ModelClass.md)\n - [Monster](docs/Monster.md)\n - [MonsterAbility](docs/MonsterAbility.md)\n - [MonsterAction](docs/MonsterAction.md)\n - [MonsterAllOfSenses](docs/MonsterAllOfSenses.md)\n - [MonsterAllOfSpeed](docs/MonsterAllOfSpeed.md)\n - [MonsterArmorClass](docs/MonsterArmorClass.md)\n - [MonsterArmorClassOneOf](docs/MonsterArmorClassOneOf.md)\n - [MonsterArmorClassOneOf1](docs/MonsterArmorClassOneOf1.md)\n - [MonsterArmorClassOneOf2](docs/MonsterArmorClassOneOf2.md)\n - [MonsterArmorClassOneOf3](docs/MonsterArmorClassOneOf3.md)\n - [MonsterArmorClassOneOf4](docs/MonsterArmorClassOneOf4.md)\n - [MonsterAttack](docs/MonsterAttack.md)\n - [MonsterMultiAttackAction](docs/MonsterMultiAttackAction.md)\n - [MonsterProficiency](docs/MonsterProficiency.md)\n - [MonsterSense](docs/MonsterSense.md)\n - [MonsterSpecialAbility](docs/MonsterSpecialAbility.md)\n - [MonsterSpell](docs/MonsterSpell.md)\n - [MonsterSpellcasting](docs/MonsterSpellcasting.md)\n - [MonsterUsage](docs/MonsterUsage.md)\n - [Multiclassing](docs/Multiclassing.md)\n - [Option](docs/Option.md)\n - [OptionOneOf](docs/OptionOneOf.md)\n - [OptionOneOf1](docs/OptionOneOf1.md)\n - [OptionOneOf10](docs/OptionOneOf10.md)\n - [OptionOneOf2](docs/OptionOneOf2.md)\n - [OptionOneOf3](docs/OptionOneOf3.md)\n - [OptionOneOf4](docs/OptionOneOf4.md)\n - [OptionOneOf5](docs/OptionOneOf5.md)\n - [OptionOneOf6](docs/OptionOneOf6.md)\n - [OptionOneOf7](docs/OptionOneOf7.md)\n - [OptionOneOf8](docs/OptionOneOf8.md)\n - [OptionOneOf9](docs/OptionOneOf9.md)\n - [OptionSet](docs/OptionSet.md)\n - [OptionSetOneOf](docs/OptionSetOneOf.md)\n - [OptionSetOneOf1](docs/OptionSetOneOf1.md)\n - [OptionSetOneOf2](docs/OptionSetOneOf2.md)\n - [Prerequisite](docs/Prerequisite.md)\n - [PrerequisiteAbilityScore](docs/PrerequisiteAbilityScore.md)\n - [Proficiency](docs/Proficiency.md)\n - [ProficiencyAllOfReference](docs/ProficiencyAllOfReference.md)\n - [Race](docs/Race.md)\n - [ResourceDescription](docs/ResourceDescription.md)\n - [Rule](docs/Rule.md)\n - [RuleSection](docs/RuleSection.md)\n - [Skill](docs/Skill.md)\n - [Spell](docs/Spell.md)\n - [SpellAllOfDamage](docs/SpellAllOfDamage.md)\n - [SpellPrerequisite](docs/SpellPrerequisite.md)\n - [Spellcasting](docs/Spellcasting.md)\n - [SpellcastingInfoInner](docs/SpellcastingInfoInner.md)\n - [SpellcastingSpellcastingAbility](docs/SpellcastingSpellcastingAbility.md)\n - [Subclass](docs/Subclass.md)\n - [SubclassAllOfSpells](docs/SubclassAllOfSpells.md)\n - [SubclassLevel](docs/SubclassLevel.md)\n - [SubclassLevelResource](docs/SubclassLevelResource.md)\n - [SubclassLevelSpellcasting](docs/SubclassLevelSpellcasting.md)\n - [Subrace](docs/Subrace.md)\n - [SubraceAllOfRace](docs/SubraceAllOfRace.md)\n - [Trait](docs/Trait.md)\n - [TraitAllOfTraitSpecific](docs/TraitAllOfTraitSpecific.md)\n - [TraitAllOfTraitSpecificOneOf](docs/TraitAllOfTraitSpecificOneOf.md)\n - [TraitAllOfTraitSpecificOneOfBreathWeapon](docs/TraitAllOfTraitSpecificOneOfBreathWeapon.md)\n - [TraitAllOfTraitSpecificOneOfBreathWeaponDamage](docs/TraitAllOfTraitSpecificOneOfBreathWeaponDamage.md)\n - [TraitAllOfTraitSpecificOneOfBreathWeaponUsage](docs/TraitAllOfTraitSpecificOneOfBreathWeaponUsage.md)\n - [TraitAllOfTraitSpecificOneOfDamageType](docs/TraitAllOfTraitSpecificOneOfDamageType.md)\n - [Weapon](docs/Weapon.md)\n - [WeaponAllOfRange](docs/WeaponAllOfRange.md)\n - [WeaponProperty](docs/WeaponProperty.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "D&D 5e API",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
"openapi-generator",
"d&d 5e api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1a6ae76f378028d7c6d8e6f0301ce0bf0f3f235edf96f901993d4cf9281717",
"md5": "2058899a4f272e0e0b551bed9221a002",
"sha256": "f90f58965f650fc8f654e5aeb6935f69ba3aa14854fc1c60fd4f9bcb2fb6ab11"
},
"downloads": -1,
"filename": "dnd5epy-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2058899a4f272e0e0b551bed9221a002",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 723046,
"upload_time": "2023-06-24T07:18:10",
"upload_time_iso_8601": "2023-06-24T07:18:10.137830Z",
"url": "https://files.pythonhosted.org/packages/dd/1a/6ae76f378028d7c6d8e6f0301ce0bf0f3f235edf96f901993d4cf9281717/dnd5epy-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c07000f0b4b1d0fb3dc7c0a476a3d7bb3d6268e5322c020680e5092045626707",
"md5": "d7bbd649b20376b9e31ae63ceaddd146",
"sha256": "047faa3d2c813da2a3976c4799da3b328ec448037366f0e4871b0865f58bfef8"
},
"downloads": -1,
"filename": "dnd5epy-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "d7bbd649b20376b9e31ae63ceaddd146",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 120837,
"upload_time": "2023-06-24T07:18:12",
"upload_time_iso_8601": "2023-06-24T07:18:12.627820Z",
"url": "https://files.pythonhosted.org/packages/c0/70/00f0b4b1d0fb3dc7c0a476a3d7bb3d6268e5322c020680e5092045626707/dnd5epy-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-24 07:18:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "dnd5epy"
}
JSON
