https://github.com/jdiaz97/iucnredlist.jl
API Wrapper for the IUCN Red List.
https://github.com/jdiaz97/iucnredlist.jl
biodiversity data-science ecology
Last synced: 8 months ago
JSON representation
API Wrapper for the IUCN Red List.
- Host: GitHub
- URL: https://github.com/jdiaz97/iucnredlist.jl
- Owner: jdiaz97
- License: mit
- Created: 2022-10-22T22:52:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T18:54:42.000Z (about 3 years ago)
- Last Synced: 2025-07-23T03:48:17.329Z (12 months ago)
- Topics: biodiversity, data-science, ecology
- Language: Julia
- Homepage:
- Size: 25.4 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IUCNRedList.jl
API Wrapper for IUCN Red List.
Are you a data scientist and you are working in biodiversity? you might find this useful.
# What this does
Implements all of the functionalities of the IUCN Red List API in an easy to use way.
In some cases, you can call 4 different endpoints from only 1 function, thanks to multiple dispatch.
# How it works
Set your token, then use all of the wonderful functionality.
```julia
set_token("Your Token")
```
(If you don't have a token, you can get it [here](https://apiv3.iucnredlist.org/api/v3/token))
Check the multiple methods of the functions. If region is not added as an argument then it will return a global assessment.
You can use ID or Name (scientific) of the species.
For more details, you can check the official [API Reference](https://apiv3.iucnredlist.org/api/v3/docs). Nevertheless the functions are pretty well commented in the source code, so pretty much everything you need is here.
# Functions
## Helpers
### `version()`
To check what version of the IUCN Red List is driving the API
```julia
version()
```
### `countries()`
To get a list of countries
```julia
countries()
```
### `species_by_country()`
To get a list of species by country isocode
```julia
species_by_country(isocode::String)
```
### `regions()`
Region identifiers
```julia
regions()
```
## Species details
### `species_all()`
Total Species published, as well as their Red List Category.
```julia
species_all(page::Int64)
species_all(page::Int64,region::String)
```
### `species_count()`
Total Species count.
```julia
species_count()
species_count(region::String)
```
### `species_citation()`
To get the citation for a given species assessment.
```julia
species_citation(name::String)
species_citation(name::String,region::String)
species_citation(id::Int64)
species_citation(id::Int64,region::String)
```
### `species_by_category()`
To get a list of species by category
```julia
species_by_category(category::String)
```
### `species_indv()`
To get information about individual species.
```julia
species_indv(name::String)
species_indv(name::String,region::String)
species_indv(id::Int64)
species_indv(id::Int64,region::String)
```
### `species_narrative()`
To get narrative information about individual species.
Please be aware that the text contains HTML markup in some places for formatting purposes.
```julia
species_narrative(name::String)
species_narrative(name::String,region::String)
species_narrative(id::Int64)
species_narrative(id::Int64,region::String)
```
### `species_synonyms()`
```julia
species_synonyms(name::String)
```
### `species_common_names()`
```julia
species_common_names(name::String)
```
### `species_occurrence()`
```julia
species_occurrence(name::String)
species_occurrence(name::String,region::String)
species_occurrence(id::Int64)
species_occurrence(id::Int64,region::String)
```
### `species_history()`
```julia
species_history(name::String)
species_history(name::String,region::String)
species_history(id::Int64)
species_history(id::Int64,region::String)
```
## Other data
### `threats()`
```julia
threats(name::String)
threats(name::String,region::String)
threats(id::Int64)
threats(id::Int64,region::String)
```
### `habitats()`
```julia
habitats(name::String)
habitats(name::String,region::String)
habitats(id::Int64)
habitats(id::Int64,region::String)
```
### `conservation_measures()`
```julia
conservation_measure(name::String)
conservation_measure(name::String,region::String)
conservation_measure(id::Int64)
conservation_measure(id::Int64,region::String)
```
### `growth_forms()`
```julia
growth_forms(name::String)
growth_forms(name::String,region::String)
growth_forms(id::Int64)
growth_forms(id::Int64,region::String)
```
### `comprehensive_groups()`
```julia
comprehensive_groups()
comprehensive_groups(group::String)
```
## Native functions
### `melt_dict()`
This will reorganize the dictionary, merging the result with the original dictionary.
```julia
melt_dict(dict::Dict)
```
### `set_token`
This will give you access to the API funcionalities
```julia
set_token(IUCNtoken::String)
```
# Usage
```julia
using IUCNRedList
set_token("YOUR TOKEN")
res = species_narrative("Quercus robur") # here you have the useful information
res = melt_dict(res) # here you reorder the information more nicely
# I like to see the data as dataframes
using DataFrames
DataFrame(res) # 1×11 DataFrame
```