PAZy API Documentation
This page describes the public PAZy API for browsing and downloading curated data. You can use these endpoints in scripts, notebooks, or directly in your browser.
Public base URL: https://pazy.eu/api
Available Endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /api/proteins/ | List proteins (JSON, paginated). |
| GET | /api/proteins/{id}/ | Get one protein with full details. |
| GET | /api/proteins/counts/ | Get count summaries for current filters. |
| GET | /api/proteins/fasta/ | Download filtered proteins as FASTA. |
| GET | /api/proteins/csv/ | Download filtered proteins as metadata CSV. |
| GET | /api/proteins/csv-sequences/ | Download filtered proteins as sequence CSV. |
| GET | /api/filters/ | List available substrates, phyla, and domains. |
| GET | /api/organisms/ | List organisms. |
| GET | /api/substrates/ | List substrates. |
| GET | /api/literature/ | List literature entries. |
Filtering
The protein endpoints (/api/proteins/*) support query filters.
- `name` (protein name contains text)
- `accession` (match an accession)
- `doi` (match DOI, with or without `doi.org/...`)
- `organism_name` (organism contains text)
- `domain` (repeatable)
- `phylum` (repeatable)
- `substrate` (repeatable; accepts abbreviations like `PET`, `PE`, `PLA`)
- `substrate_mode=or|and` (for repeated `substrate` values)
- `sort` and `dir=asc|desc`
For repeated filters, `domain` and `phylum` use OR logic. For `substrate`, choose OR/AND with substrate_mode.
Protein Response Fields
The protein list/detail endpoints include helper fields for external resources.
- `organism` and `strain_identifier` for taxonomy/strain context
- `accessions[*].external_url` when PAZy has a resolved external target (for example ENA vs NCBI)
- `bacdive_url` as a direct BacDive link only when a unique BacDive match exists (otherwise `null`)
Examples
PET proteins as JSON
https://pazy.eu/api/proteins/?substrate=PETPET + Actinomycetota proteins as FASTA
https://pazy.eu/api/proteins/fasta/?substrate=PET&phylum=ActinomycetotaProteins that match all selected substrates (AND)
https://pazy.eu/api/proteins/?substrate=PET&substrate=PUR&substrate_mode=andCounts for PET proteins
https://pazy.eu/api/proteins/counts/?substrate=PETNotes
Use /api/filters/ to retrieve the currently available substrate abbreviations, phyla, and domains before constructing filter queries.
If you prefer browsing the web interface instead of direct API use, see the Proteins and Plastics pages.