SpeciesDatabaseApi 1.1.0
See the version list below for details.
dotnet add package SpeciesDatabaseApi --version 1.1.0
NuGet\Install-Package SpeciesDatabaseApi -Version 1.1.0
<PackageReference Include="SpeciesDatabaseApi" Version="1.1.0" />
paket add SpeciesDatabaseApi --version 1.1.0
#r "nuget: SpeciesDatabaseApi, 1.1.0"
// Install SpeciesDatabaseApi as a Cake Addin #addin nuget:?package=SpeciesDatabaseApi&version=1.1.0 // Install SpeciesDatabaseApi as a Cake Tool #tool nuget:?package=SpeciesDatabaseApi&version=1.1.0
<img src="https://raw.githubusercontent.com/sn4k3/SpeciesDatabaseApi/master/icon.png" width='64'> Species Database Api
Queries and fetch data from species, taxon, regions and conservation database(s) to retrieve information using the provider API.
🌐 Clients
🤝 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)
private static readonly WormsClient Client = new WormsClient();
private async void Main()
{
var result = await Client.GetAphiaRecordByAphiaId(105792);
Console.WriteLine(result);
}
<details> <summary>Result:</summary>
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
</details>
Example (IUCN)
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);
}
}
<details> <summary>Result:</summary>
TaxonName: White Shark, Primary: True, Language: eng
TaxonName: Great White Shark, Primary: False, Language: eng
</details>
🗔 Command-line
The project 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:
# Usage:
# SpeciesDatabaseCmd [command] [options]
#
# Options:
# --version Show version information
# -?, -h, --help Show help and usage information
#
# Commands:
# WORMS Query - World Register of Marine Species (https://marinespecies.org)
# IUCN Query - International Union for Conservation of Nature (http://iucnredlist.org)
# MARINEREGIONS Query - Marine Regions (https://marineregions.org)
# SPECIES+ Query - Species+/CITES (https://speciesplus.net)
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:
dotnet add package SpeciesDatabaseApi
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.