Gbif requests

MatchStatus

Bases: str, Enum

Represent the GBIF match status

Represent the GBIF match result model

Parameters:

Name	Type	Description	Default
`status`	`MatchStatus`		required
`data`	`dict \| None`		`None`

gbif_parser_request(name: str) -> dict | None

Make a parser request to GBIF API

Parameters:

Name	Type	Description	Default
`name`	`str`	The name of the taxon to parse	required

Returns:

Type	Description
`dict \| None`	dict \| None: The GBIF parser response for the specific taxon

gbif_match_request(
    focal_name: str, rank: TaxonRank
) -> GBIFMatchResult

Make a match request to GBIF API

Parameters:

Name	Type	Description	Default
`focal_name`	`str`	The name of the taxon	required
`rank`	`TaxonRank`	The rank of the taxon	required

Returns:

Name	Type	Description
`GBIFMatchResult`	`GBIFMatchResult`	The GBIF match result for the specific taxon

gbif_search_request(
    focal_name: str, rank: TaxonRank
) -> list[dict] | None

Make a search request to GBIF API

Parameters:

Name	Type	Description	Default
`focal_name`	`str`	The name of the taxon	required
`rank`	`TaxonRank`	The rank of the taxon	required

Returns:

Type	Description
`list[dict] \| None`	list[dict] \| None: The GBIF key for the specific taxon

gbif_vernaculars_request(
    gbif_key: str,
) -> list[dict] | None

Make a vernaculars request to GBIF API

Parameters:

Name	Type	Description	Default
`gbif_key`	`str`	The GBIF key of the taxon	required

Returns:

Type	Description
`list[dict] \| None`	list[dict] \| None: The GBIF vernaculars for the specific taxon