Skip to content

CasiahJade/Pathfinder-2e-API

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

  1. Navigate to the repo directory and execute:

    python3 api.py
  2. Open a browser and point it to https://localhost:5000

About

Creating a PF2 version of Iron Kingdoms

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%