Loading…
Loading…
Every endpoint anyone may call without a login, from the Hub's own description. For the rest, use a personal API token or a login: see the API guide. As an OpenAPI file: public-api.json.
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/access/country-routes | List Country Routes |
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/accounts/register | Register |
POST | /api/v1/accounts/login | Login |
POST | /api/v1/accounts/signup | Signup |
POST | /api/v1/accounts/confirm-email | Confirm Email |
POST | /api/v1/accounts/resend-confirmation | Resend Confirmation |
POST | /api/v1/accounts/request-password-reset | Request Password Reset |
POST | /api/v1/accounts/reset-password | Reset Password |
GET | /api/v1/accounts/{username}/avatar | Get Avatar |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/catalog/species | List Species |
GET | /api/v1/catalog/species/facets | Get Species Facets |
GET | /api/v1/catalog/species/{species_id} | Get Species |
GET | /api/v1/catalog/species/{species_id}/strains | List Species Strains |
GET | /api/v1/catalog/taxonomy-tree | Get Taxonomy Tree |
GET | /api/v1/catalog/species/{species_id}/related | Get Related Species |
GET | /api/v1/catalog/published-trees | Get Published Trees |
GET | /api/v1/catalog/species/{species_id}/associations | List Species Associations |
GET | /api/v1/catalog/one-health/associations/export.csv | Export One Health Associations |
GET | /api/v1/catalog/one-health/associations | List One Health Associations |
GET | /api/v1/catalog/species/{species_id}/local-names | List Species Local Names |
GET | /api/v1/catalog/sequences | List Sequence Records |
GET | /api/v1/catalog/sequences/facets | Get Sequence Facets |
GET | /api/v1/catalog/sequences/{sequence_id} | Get Sequence Record |
GET | /api/v1/catalog/sequences/{sequence_id}/sra-references | List Sra References |
GET | /api/v1/catalog/sequences/{sequence_id}/file | Get Sequence File |
GET | /api/v1/catalog/sequences/{sequence_id}/download-count | Get Sequence Download Count |
GET | /api/v1/catalog/sequences/{sequence_id}/file.fai | Get Sequence File Index |
GET | /api/v1/catalog/sequences/{sequence_id}/annotation.gff | Get Sequence Annotation Gff |
GET | /api/v1/catalog/sequences/{sequence_id}/cds | Get Sequence Cds Fasta |
GET | /api/v1/catalog/sequences/{sequence_id}/proteins | Get Sequence Protein Fasta |
GET | /api/v1/catalog/raw-reads/by-origin/{origin_node_id}/{origin_entity_id}/file | Get Raw Reads File |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/cellular-imaging | List Cellular Imaging Records |
GET | /api/v1/cellular-imaging/facets | Get Cellular Imaging Facets |
GET | /api/v1/cellular-imaging/{record_id} | Get Cellular Imaging Record |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/compute/node-services | List Node Service Targets |
GET | /api/v1/compute/tools | List Tools |
GET | /api/v1/compute/approved-base-images | List Approved Base Images |
GET | /api/v1/compute/participation-terms | List Participation Terms |
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/contact | Submit Contact Message |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/contributors/public | List Public Contributors |
GET | /api/v1/contributors/public/{profile_id} | Get Public Contributor |
GET | /api/v1/contributors/nodes | List Accepting Nodes |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/curation/curators | Public Curators |
GET | /api/v1/curation/dataset-citation | Dataset Citation |
GET | /api/v1/curation/associations/{association_id}/history | History |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/derived-analysis/results | List Derived Analysis Results |
GET | /api/v1/derived-analysis/results/facets | Get Derived Analysis Facets |
GET | /api/v1/derived-analysis/results/{result_id} | Get Derived Analysis Result |
GET | /api/v1/derived-analysis/results/{result_id}/file | Get Derived Analysis Result File |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/discovery/matrix | Get Completeness Matrix |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/edna/classifications | List Edna Classifications |
GET | /api/v1/edna/sites | List Site Summaries |
GET | /api/v1/edna/sites/{site_name} | Get Site Summary |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/ena-submission/enabled | Get Ena Submission Enabled |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/export/dcat | Get Dcat Catalog |
GET | /api/v1/export/darwin-core.zip | Get Darwin Core Archive |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/featured-publications | List Featured Publications |
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/federation/nodes | Apply As Node |
POST | /api/v1/federation/hub-applications | Apply Via Hub |
GET | /api/v1/federation/node-names | Get Node Names |
GET | /api/v1/federation/contributions | Get Contributions |
GET | /api/v1/federation/contributions/earlier-file-requests | Get Earlier File Requests |
GET | /api/v1/federation/contributions/growth | Get Contribution Growth |
GET | /api/v1/federation/impact | Get Impact |
GET | /api/v1/federation/impact.csv | Get Impact Csv |
GET | /api/v1/federation/status | Get Public Status |
GET | /api/v1/federation/nodes/{node_id}/analytics-preference | Get Node Analytics Preference |
GET | /api/v1/federation/nodes/{node_id}/update-preference | Get Node Update Preference |
GET | /api/v1/federation/nodes/{node_id}/license-acknowledgment | Get Node License Acknowledgment |
GET | /api/v1/federation/.well-known/jwt-public-key | Get Jwt Public Key |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/field-specimen-images | List Field Specimen Images |
GET | /api/v1/field-specimen-images/facets | Get Field Specimen Image Facets |
GET | /api/v1/field-specimen-images/{image_id} | Get Field Specimen Image |
GET | /api/v1/field-specimen-images/{image_id}/preview | Get Field Specimen Image Preview |
GET | /api/v1/field-specimen-images/{image_id}/download-count | Get Field Specimen Image Download Count |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/geographic-range/{species_id} | Get Species Range Summary |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/hosted-data | List Datasets |
GET | /api/v1/hosted-data/{dataset_id} | Get Dataset |
GET | /api/v1/hosted-data/{dataset_id}/files/{index} | Download File |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/identifiers/{citable_id} | Get Citable Record |
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/mailing-list/subscribe | Subscribe |
POST | /api/v1/mailing-list/unsubscribe | Unsubscribe |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/metabolic-profiles | List Metabolic Profile References |
GET | /api/v1/metabolic-profiles/facets | Get Metabolic Profile Facets |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/metabolomics/profiles | List Metabolomics Profiles |
GET | /api/v1/metabolomics/profiles/facets | Get Metabolomics Facets |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/metagenomics/profiles | List Metagenomic Profiles |
GET | /api/v1/metagenomics/sites | List Site Summaries |
GET | /api/v1/metagenomics/sites/{site_name} | Get Site Summary |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/news | List News |
GET | /api/v1/news/feed.xml | Get News Feed |
GET | /api/v1/news/whats-new | Get Whats New |
GET | /api/v1/news/inline-images/{image_id} | Get News Inline Image |
GET | /api/v1/news/preview/{token} | Get News Preview |
GET | /api/v1/news/preview/{token}/image | Get News Preview Image |
GET | /api/v1/news/{slug} | Get News Item |
GET | /api/v1/news/{item_id}/social-card | Get News Item Social Card |
GET | /api/v1/news/{item_id}/image | Get News Item Image |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/node-profiles/areas | List Research Areas |
GET | /api/v1/node-profiles | List Public Profiles |
GET | /api/v1/node-profiles/web-services | List Web Services |
POST | /api/v1/node-profiles/{node_id}/enquiries | Send Message To Node |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/outreach/training | List Training Materials |
GET | /api/v1/outreach/training/download-all | Download All Training Materials |
GET | /api/v1/outreach/training/{material_id}/file | Download Training Material |
GET | /api/v1/outreach/training/{material_id}/files/{file_id} | Download Training Material File |
GET | /api/v1/outreach/training/{material_id}/preview | Preview Training Material |
GET | /api/v1/outreach/training/{material_id}/files/{file_id}/preview | Preview Training Material File |
GET | /api/v1/outreach/public-materials | List Public Outreach Materials |
GET | /api/v1/outreach/public-materials/download-all | Download All Public Outreach Materials |
GET | /api/v1/outreach/public-materials/{material_id} | Get Public Outreach Material |
GET | /api/v1/outreach/public-materials/{material_id}/file | Download Public Outreach Material |
GET | /api/v1/outreach/public-materials/{material_id}/files/{file_id} | Download Public Outreach Material File |
GET | /api/v1/outreach/public-materials/{material_id}/preview | Preview Public Outreach Material |
GET | /api/v1/outreach/public-materials/{material_id}/social-card | Public Outreach Material Social Card |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/proteins | List Protein Records |
GET | /api/v1/proteins/orthologs | List Ortholog Clusters |
GET | /api/v1/proteins/facets | Get Protein Facets |
GET | /api/v1/proteins/{protein_id} | Get Protein Record |
GET | /api/v1/proteins/{protein_id}/file | Get Protein File |
GET | /api/v1/proteins/{protein_id}/download-count | Get Protein Download Count |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/proteomics/profiles | List Proteomics Profiles |
GET | /api/v1/proteomics/project-references | List Proteomics Project References |
GET | /api/v1/proteomics/facets | Get Proteomics Facets |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/publications | List Publications |
GET | /api/v1/publications/facets | Get Publication Facets |
GET | /api/v1/publications/used-in | Get Papers Using |
GET | /api/v1/publications/{publication_id} | Get Publication |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/stewardship/moves/node/{move_id}/file | Move File |
POST | /api/v1/stewardship/moves/node/{move_id}/delivered | Move Delivered |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/structures | List Structures |
GET | /api/v1/structures/facets | Get Structure Facets |
GET | /api/v1/structures/{structure_id} | Get Structure |
GET | /api/v1/structures/{structure_id}/pdb | Get Structure Pdb |
GET | /api/v1/structures/{structure_id}/download-count | Get Structure Download Count |
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/support | Submit Support |
GET | /api/v1/support/endorsements | List Endorsements |
GET | /api/v1/support/stats | Endorsement Stats |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/team | List Team Members |
GET | /api/v1/team/{member_id}/photo | Get Team Member Photo |
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/tickets/by-token | Get Ticket By Token |
POST | /api/v1/tickets/by-token/messages | Add Submitter Message |
POST | /api/v1/tickets/webhooks/github | Github Webhook |
POST | /api/v1/tickets/webhooks/linear | Linear Webhook |
GET | /api/v1/outreach/public-materials/{material_id}/files/{file_id}/social-card | Public Outreach File Social Card |
GET | /api/v1/outreach/public-materials/{material_id}/files/{file_id}/preview | Preview Public Outreach Material File |