# GBIF on Onekey

> 4 endpoints for GBIF (4 stable, 0 beta), 1 to 5 credits each. Category: Science & research. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/gbif
Reference (Markdown): https://onekey.dev/docs/api/gbif.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped GBIF endpoints return each:

- `entity.name` (string): 4
- `entity.id` (string): 3
- `entity.stats.rank` (integer): 3
- `entity.status` (string): 3
- `content.createdAt` (ISO 8601 date): 1
- `content.id` (string): 1
- `entity.country` (string): 1
- `place.lat` (number): 1
- `place.lon` (number): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### gbif.occurrences

Recent GBIF occurrence records for a scientific name.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gbif/occurrences?name=Puma%20concolor` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Scientific name
- Fields returned: `content.id`, `entity.name`, `entity.country`, `content.createdAt`, `place.lat`, `place.lon`
- Reference: https://onekey.dev/docs/api/gbif/occurrences.md

### gbif.species

GBIF taxon by key.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/gbif/species?key=5219404` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `key` (string, required): GBIF taxon key
- Fields returned: `entity.id`, `entity.name`, `entity.stats.rank`, `entity.status`, `ext.commonName`, `ext.kingdom`
- Reference: https://onekey.dev/docs/api/gbif/species.md

### gbif.species_match

Match a name to the GBIF backbone taxonomy.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/gbif/species_match?name=Puma%20concolor` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Scientific name, e.g. Puma concolor
- Fields returned: `entity.id`, `entity.name`, `entity.stats.rank`, `entity.status`, `ext.kingdom`, `ext.confidence`
- Reference: https://onekey.dev/docs/api/gbif/species_match.md

### gbif.species_search

Search GBIF species and taxa.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gbif/species_search?q=puma` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `entity.name`, `entity.stats.rank`, `entity.status`, `ext.commonName`, `ext.kingdom`
- Reference: https://onekey.dev/docs/api/gbif/species_search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/gbif/species?key=5219404" \
  -H "x-api-key: YOUR_API_KEY"
```