Assessment1
Return assessment data relating to a specific <code>assessment_id</code>. You do not need to supply a latest <code>assessment_id</code>; you can therefore return data on latest and historic assessments if the <code>assessment_id</code> is known. You can gather a list of current and historic <code>assessment_id</code> for a specific species by using <code>api/v4/taxa/scientific_name/{scientific_name}</code>
GET/api/v4/assessment/{assessment_id}Retrieves an assessment
Parameters| Name | In | Required | Type |
|---|
assessment_id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | assessment found | — |
401 | unauthorised | — |
404 | not found | — |
Biogeographical Realms2
Return the latest assessments for a biogeographical realm.
GET/api/v4/biogeographical_realms/Returns a list of biogeographic realm codes
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/biogeographical_realms/{code}Returns a collection of assessments for a biogeographical realm code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | biogeographical realm found | — |
401 | unauthorised | — |
404 | biogeographical realm not found | — |
Comprehensive Groups2
Return the latest assessments for a comprehensive group
GET/api/v4/comprehensive_groups/Returns a list of comprehensive groups
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/comprehensive_groups/{name}Returns a collection of assessments for a comprehensive group name
Parameters| Name | In | Required | Type |
|---|
name | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | comprehensive group found | — |
401 | unauthorised | — |
404 | comprehensive group not found | — |
Conservation Actions2
Description coming soon...
GET/api/v4/conservation_actions/returns a list of conservation actions
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/conservation_actions/{code}returns a collection of assessments for a conservation action code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | conservation action found | — |
401 | unauthorised | — |
404 | conservation action not found | — |
Countries2
Return the latest assessments for a given country.
GET/api/v4/countries/Returns a list of countries by ISO alpha-2 code
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/countries/{code}Returns a collection of assessments for a given country ISO alpha-2 code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | country found | — |
401 | unauthorised | — |
404 | country not found | — |
FAOs2
Documentation coming soon..
GET/api/v4/faos/Returns a list of FAOs
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/faos/{code}Returns a collection of assessments for an FAO code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | fao found | — |
401 | unauthorised | — |
404 | fao not found | — |
Growth Forms2
Return the latest assessments for a given growth form.
GET/api/v4/growth_forms/Returns a list of growth forms
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/growth_forms/{code}Returns a collection of assessments for a given growth form code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | measure found | — |
401 | unauthorised | — |
404 | measure not found | — |
Green Status1
Return the latest Green Status assessments.
GET/api/v4/green_status/allReturns a list of all Green Status assessments
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
Habitats2
Return the latest assessments for a given habitat (e.g. Forest - Temperate or Marine Intertidal). These habitat codes correspond to the IUCN Red List Habitats Classification Scheme (v3.1)
GET/api/v4/habitats/Returns a list of habitat codes.
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/habitats/{code}Returns a collection of assessments for a given habitat code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | habitat found | — |
401 | unauthorised | — |
404 | habitat not found | — |
Information2
Endpoints for supplying general API-specific information.
GET/api/v4/information/api_versionReturns the current version number of the IUCN Red List of Threatened Species API
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/information/red_list_versionReturns the current IUCN Red List of Threatened Species version
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
Population Trends2
Return a list of the latest assessments based on a population trend (i.e. increasing, decreasing stable or unknown)
GET/api/v4/population_trends/Returns a list of population trends
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/population_trends/{code}Returns a collection of assessments for a given population trend code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | population trend found | — |
401 | unauthorised | — |
404 | population trend not found | — |
Red List Categories2
Return a list of the latest assessments for a given category. (Not Evaluated, Data Deficient, Least Concern, Near Threatened, Vulnerable, Endangered, Critically Endangered, Extinct in the Wild and Extinct).
GET/api/v4/red_list_categories/Returns a list of Red List categories
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/red_list_categories/{code}Returns a collection of assessments for a given Red List category code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | red list category found | — |
401 | unauthorised | — |
404 | red list category not found | — |
Research2
Return a list of the latest assessments for a given research category.
GET/api/v4/research/Returns a list of habitat codes.
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/research/{code}Returns a collection of assessments for a given research code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | research found | — |
401 | unauthorised | — |
404 | research not found | — |
Scopes2
Return latest assessments for a given geographical assessment scope (e.g. Global, Mediterranean)
GET/api/v4/scopes/returns a list of scopes
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/scopes/{code}Returns a collection of assessments for a given scope code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | scope found | — |
401 | unauthorised | — |
404 | scope not found | — |
Statistics1
Return aggregated statistics.
GET/api/v4/statistics/countReturn count of the number of species with assessments
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
Stresses2
Return a list of the latest assessments based on the stresses species’ are subject to (e.g. Ecosystem degradation, species disturbance etc.)
GET/api/v4/stresses/Returns a list of stressors
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/stresses/{code}returns a collection of assessments for a given stress code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | stress found | — |
401 | unauthorised | — |
404 | stress not found | — |
Systems2
Return assessments belonging to broad systems (e.g. terrestrial, freshwater or marine)
GET/api/v4/systems/Returns a list of systems
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/systems/{code}Returns a collection of assessments for a given system code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | system found | — |
401 | unauthorised | — |
404 | system not found | — |
Taxa14
Return summary assessment data at the species level and other higher taxonomic levels (kingdom to family, inclusive). When querying at the species level, the API returns the latest and historic assessment information.
GET/api/v4/taxa/class/Returns a list of all class names
Responses| Status | Description | Schema |
|---|
200 | class found | — |
GET/api/v4/taxa/class/{class_name}Returns a collection of the latests assessments for a given class_name
Parameters| Name | In | Required | Type |
|---|
class_name | path | yes | string |
year_published | query | no | integer |
latest | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | class found | — |
401 | unauthorised | — |
GET/api/v4/taxa/family/Returns a list of all family names
Responses| Status | Description | Schema |
|---|
200 | family found | — |
401 | unauthorised | — |
GET/api/v4/taxa/family/{family_name}Returns a collection of the latests assessments for a given family_name
Parameters| Name | In | Required | Type |
|---|
family_name | path | yes | string |
year_published | query | no | integer |
latest | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | family found | — |
401 | unauthorised | — |
GET/api/v4/taxa/kingdom/Returns a list of all kingdom names
Responses| Status | Description | Schema |
|---|
200 | kingdom found | — |
401 | unauthorised | — |
GET/api/v4/taxa/kingdom/{kingdom_name}Returns a collection of the latests assessments for a given kingdom_name
Parameters| Name | In | Required | Type |
|---|
kingdom_name | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | kingdom found | — |
401 | unauthorised | — |
GET/api/v4/taxa/order/Returns a list of all order names
Responses| Status | Description | Schema |
|---|
200 | order found | — |
401 | unauthorised | — |
GET/api/v4/taxa/order/{order_name}Returns a collection of the latests assessments for a given order_name
Parameters| Name | In | Required | Type |
|---|
order_name | path | yes | string |
year_published | query | no | integer |
latest | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | order found | — |
401 | unauthorised | — |
GET/api/v4/taxa/phylum/Returns a list of all phylum names
Responses| Status | Description | Schema |
|---|
200 | kingdom found | — |
401 | unauthorised | — |
GET/api/v4/taxa/phylum/{phylum_name}Returns a collection of the latests assessments for a given phylum_name
Parameters| Name | In | Required | Type |
|---|
phylum_name | path | yes | string |
year_published | query | no | integer |
latest | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | phylum found | — |
401 | unauthorised | — |
GET/api/v4/taxa/possibly_extinctReturns a collection of the all latest global assessments for taxa that are possibly extinct
Responses| Status | Description | Schema |
|---|
200 | assessments found | — |
401 | unauthorised | — |
GET/api/v4/taxa/possibly_extinct_in_the_wildReturns a collection of the all latest global assessments for taxa that are possibly extinct in the wild
Responses| Status | Description | Schema |
|---|
200 | assessments found | — |
401 | unauthorised | — |
GET/api/v4/taxa/scientific_nameReturns a collection of assessments for a given genus_name and species_name (i.e. Latin binomial) and optional infra_name (i.e. Latin trinomial)
Parameters| Name | In | Required | Type |
|---|
genus_name | query | yes | string |
species_name | query | yes | string |
infra_name | query | no | string |
subpopulation_name | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | taxon found | — |
401 | unauthorised | — |
404 | taxon not found | — |
GET/api/v4/taxa/sis/{sis_id}Returns a collection of assessments for a given SIS id
Parameters| Name | In | Required | Type |
|---|
sis_id | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | taxon found | — |
401 | unauthorised | — |
404 | taxon not found | — |
Threats2
Return a list of the latest assessments which are subject to a specific threat (e.g. energy production and mining, climate change and severe weather)
GET/api/v4/threats/Returns a list of threats
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/threats/{code}Returns a collection of assessments for a given threat code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | threat found | — |
401 | unauthorised | — |
404 | threat not found | — |
Use and Trade2
Return a list of the latest assessments which are subject to a specific uses and trade.
GET/api/v4/use_and_trade/Returns a list of use and trades
Responses| Status | Description | Schema |
|---|
200 | successful | — |
401 | unauthorised | — |
GET/api/v4/use_and_trade/{code}Returns a collection of assessments for a given use and trade code
Parameters| Name | In | Required | Type |
|---|
code | path | yes | string |
page | query | no | integer |
year_published | query | no | integer |
latest | query | no | boolean |
possibly_extinct | query | no | boolean |
possibly_extinct_in_the_wild | query | no | boolean |
scope_code | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | use and trade found | — |
401 | unauthorised | — |
404 | Use and trade code not found | — |
AssessmentSearch1
GET/api/v4/assessment_searchSearches for assessments
Parameters| Name | In | Required | Type |
|---|
filter_on[] | query | yes | array |
page | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | valid filter_on | — |
400 | empty search options | — |
401 | unauthorised | — |