https://github.com/sn4k3/speciesdatabaseapi
Queries and fetch data from species, taxon and conservation database(s) to retrieve information using the provider API
https://github.com/sn4k3/speciesdatabaseapi
api-rest biota conservation database iucn marine nature regions register species taxomony taxomy world worms
Last synced: about 2 months ago
JSON representation
Queries and fetch data from species, taxon and conservation database(s) to retrieve information using the provider API
- Host: GitHub
- URL: https://github.com/sn4k3/speciesdatabaseapi
- Owner: sn4k3
- License: mit
- Created: 2023-08-11T00:38:18.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-20T03:18:44.000Z (almost 2 years ago)
- Last Synced: 2024-08-31T04:52:48.861Z (9 months ago)
- Topics: api-rest, biota, conservation, database, iucn, marine, nature, regions, register, species, taxomony, taxomy, world, worms
- Language: C#
- Homepage:
- Size: 420 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/LICENSE.txt)
[](#)
[](#)
[](https://www.nuget.org/packages/SpeciesDatabaseApi)
[](https://github.com/sponsors/sn4k3)
#  Species Database Api
Queries and fetch data from species, taxon, regions and conservation database(s) to retrieve information using the provider API.
## 🌐 Clients
| Name / Provider | Class | Terms of use |
| ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| [Barcode of Life Data Sytem (BoldSystems)](https://www.boldsystems.org) | [BoldSystemsClient](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/SpeciesDatabaseApi/BoldSystems/BoldSystemsClient.cs) | [Terms of use](https://www.boldsystems.org/index.php/Resources/whatIsBOLD) |
| [International Union for Conservation of Nature (IUCN)](https://www.iucn.org) | [IucnClient](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/SpeciesDatabaseApi/Iucn/IucnClient.cs) | [Terms of use](http://apiv3.iucnredlist.org/about) |
| [Marine Regions](https://www.marineregions.org) | [MarineRegionsClient](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/SpeciesDatabaseApi/MarineRegions/MarineRegionsClient.cs) | [Terms of use](https://www.marineregions.org/disclaimer.php) |
| [Species+/CITES](https://www.speciesplus.net) | [SpeciesPlusClient](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/SpeciesDatabaseApi/SpeciesPlus/SpeciesPlusClient.cs) | [Terms of use](https://www.speciesplus.net/terms-of-use) |
| [World Register of Marine Species (WoRMS)](https://www.marinespecies.org) | [WormsClient](https://github.com/sn4k3/SpeciesDatabaseApi/blob/master/SpeciesDatabaseApi/MarineSpecies/WormsClient.cs) | [Terms of use](https://www.marinespecies.org/about.php#terms) |
## 🤝 Terms of use
Before the use of any provider you must accept and follow the terms of use of each used client.
Please refer to the "terms of use" from the above links.
## 🧬 Structure
- Calls follow the async programming
- Returned data have a class data model
## Example (WoRMS)
```C#
private static readonly WormsClient Client = new WormsClient();
private async void Main()
{
var result = await Client.GetAphiaRecordByAphiaId(105792);
Console.WriteLine(result);
}
```
Result:
```text
AphiaId: 105792
Url: https://marinespecies.org/aphia.php?p=taxdetails&id=105792
ScientificName: Carcharhinus leucas
Authority: (Müller & Henle 1839)
TaxonRankId: 220
Rank: Species
Status: accepted
UnacceptReason:
ValidAphiaID: 105792
ValidName: Carcharhinus leucas
ValidAuthority: (Müller & Henle 1839)
ParentNameUsageId: 105719
Kingdom: Animalia
Phylum: Chordata
Class: Elasmobranchii
Order: Carcharhiniformes
Family: Carcharhinidae
Genus: Carcharhinus
Citation: Froese R. and D. Pauly. Editors. (2023). FishBase. Carcharhinus leucas (Müller & Henle 1839). Accessed through: World Register of Marine Species at: https://marinespecies.org/aphia.php?p=taxdetails&id=105792 on 2023-08-09
lsId: urn:lsid:marinespecies.org:taxname:105792
IsMarine: 1
IsBrackish: 1
IsFreshwater: 1
IsTerrestrial: 0
IsExtinct:
MatchType: Exact
Modified: 15/01/2008 17:27:08
```
## Example (IUCN)
```C#
private static readonly IucnClient Client = new IucnClient("your-api-key");
private async void Main()
{
var results = await Client.GetSpecieCommonNames("Carcharodon carcharias");
foreach(var result in results)
{
Console.WriteLine(result);
}
}
```
Result:
```text
TaxonName: White Shark, Primary: True, Language: eng
TaxonName: Great White Shark, Primary: False, Language: eng
```
## 🗔 Command-line
The project **[SpeciesDatabaseCmd](https://github.com/sn4k3/SpeciesDatabaseApi/tree/master/SpeciesDatabaseCmd)** allow to call all the API using the command-line and also provide a sample on how to use the library.
Run the "SpeciesDatabaseCmd.exe" and follow the in-terminal instructions to call the commands.
### Example:
```bash
# Usage:
# SpeciesDatabaseCmd [command] [options]
#
# Options:
# --version Show version information
# -?, -h, --help Show help and usage information
#
# Commands:
# BOLDSYSTEMS Query - Barcode of Life Data Sytem (https://www.boldsystems.org)
# IUCN Query - International Union for Conservation of Nature (http://www.iucnredlist.org)
# MARINEREGIONS Query - Marine Regions (https://www.marineregions.org)
# SPECIES+ Query - Species+/CITES (https://www.speciesplus.net)
# WORMS Query - World Register of Marine Species (https://www.marinespecies.org)
SpeciesDatabaseCmd.exe IUCN SpecieCommonNames "Carcharodon carcharias"
> Name: Carcharodon carcharias
> Error:
> Message:
> IsSuccess: True
> Count: 2
> Results: 2
> ## Result[0]:
> TaxonName: White Shark
> Primary: True
> Language: eng
> ## Result[1]:
> TaxonName: Great White Shark
> Primary: False
> Language: eng
```
# 📦 Link package (Visual Studio)
- Via "Manage NuGet packages"
- Manually via terminal:
```powershell
dotnet add package SpeciesDatabaseApi
```