Pathfinder-2e-API
Pathfinder-2e-API copied to clipboard
Pathfinder-2e-API
Purpose
Provide a standardized set of Pathfinder Second Edition data for community use.
Goals
- Fast
- Lightweight
- Current
Data Source
The API gets its data from the official SRD - Archives of Nethys. It caches data it retrieves for 20 minutes, which is tracked per item (e.g. the Human Ancestry will go stale separately from the Dwarf Ancestry).
How to Use V1
Access (url)/api/v1/(resource)?(options)
Ancestries
(resource) = ancestries
Options:
- name
- Not case sensitive
- (url)/api/v1/ancestries?name=dwarf
- (url)/api/v1/ancestries?name=dWaRF
Running Locally
-
Navigate to the repo directory and execute:
python3 api.py -
Open a browser and point it to http://localhost:5000