API v2

API V2

This release represents a full update to a new structure, which provides greater detail on all elements. It also includes a new source management system that allows for handling more complex sets of game-rules.

🚨 BREAKING CHANGE: As of this release, all calls to the API require a version prefix.

Eventually, the default route will be switched to v2/, but for now we thought it best to make it extremely obvious that things are changing for consumers of the un-prefixed v1 API, as a way to alert folks that the v1 API is now deprecated and under limited maintenance. We've been including warning headers for a while, but know those are not frequently checked.

If you are experiencing issues, you can simply add a /v1/ to your URLS for now (eg. api.open5e.com/v1/monsters). But the v1 api will not be indefinitely maintained from this point forward. Future updates or changes may cause degradation of those endpoints, so you should start migrating to v2 at your earliest opportunity.

What's Changed

• Fixed parsing reaction conditions without parentheses by @blakewatson in #842
• Fix spell data regressions and omissions by @eepMoody in #844
• Convert distance fields to integer by @eepMoody in #845
• fixed bugs in srd-2024 CreatureAction data (closes #847) by @calumbell in #849
• Fixed markdown errors in Creature Spellcasting actions/traits by @calumbell in #855
• Updated SRD-2014 Dragon breath weapon recharge data by @calumbell in #853
• Removed unneed asterisks from FeatBenefit 'desc' fields by @calumbell in #852
• Fixed bugs in srd-2024 spell markdown (closes #857) by @calumbell in #859
• Added missing srd-2024 Creature Bonus Actions by @calumbell in #860
• Remove srd-2014 Mithral and Adamantine Hide Armor by @calumbell in #861
• Bugfix: added missing dash to Black Flag Mechanist starting equpiment by @calumbell in #863
• Added missing subclass data to srd-2024/ClassFeatureItem.json by @calumbell in #868
• [BUGFIX] Fixed typos in srd-2024 Spell casting times by @calumbell in #870
• Added ExcludeFieldsMixin to exclude fields via query parameters by @calumbell in #872
• Added missing srd-2024 Dragon CreatureAttackAction data by @calumbell in #874
• [V1] Remove Manifest endpoint by @calumbell in #875
• [V2 DATA] Added Character Creation rules from srd-2024 by @calumbell in #878
• Add ability to filter monsters by environment by @stevennoto in #884
• [BUGFIX] Fixed typo in srd-2024 Adult Green Dragon Spellcasting action by @calumbell in #891
• [BUGFIX] Fixed data errors on /v2/rulesets/srd_combat-sequence by @calumbell in #893
• Add missing ClassFeatureItem for srd-2024 Fighter Two Extra Attacks action by @calumbell in #895
• Removed server/vector_index.pkl (in line with .gitignore) by @calumbell in #883
• [BUGFIX] Removed leading slashes from Image "file_urls" by @calumbell in #886
• [CI/CD] Upgrade Github Action versions to Node 24 compatable versions by @calumbell in #901
• Feature: split V2 Item model into Item and MagicItem models by @calumbell in #889
• [BUGFIX] GameContentSerializer now inherits from ModelSerializer by @calumbell in #899
• Bugfix: seperated mixed up V1/V2 endpoints by @calumbell in #890
• [BUGFIX] Fixed EagerLoadingMixin early return error by @calumbell in #898
• Bump django from 5.2.1 to 5.2.12 by @dependabot[bot] in #904
• Bump requests from 2.32.3 to 2.33.0 by @dependabot[bot] in #905
• Bump urllib3 from 2.4.0 to 2.6.3 by @dependabot[bot] in #906
• Bump django from 5.2.12 to 5.2.13 by @dependabot[bot] in #908
• [BUGFIX / DATA] srd-2014 skeleton resistances/immunities by @calumbell in #907
• [BUGFIX / DATA] srd-2014 Brass Dragons markdown fixes by @calumbell in #912
• [QA / DATA] srd-2024 Goliath Markdown fixes by @calumbell in #909
• [QA / FEATURE] Consolide CR fields into single "challenge_rating" field by @calumbell in #910

New Contributors

• @blakewatson made their first contribution in #842
• @stevennoto made their first contribution in #884

Full Changelog: v1.12.0...v2.0.0