omnilab/col API reference

Omnilab\Col

ColSource class

final class ColSource extends HttpSource ColSource.php:33

The Catalogue of Life, through ChecklistBank's API (api.checklistbank.org): a taxon or a synonym by its COL id, by the GBIF key that names it (GBIF's taxonomy is the Catalogue of Life eXtended Release since June 2026: its keys are COL's ids) or by its name - its authority, rank, status, classification, group, vernacular names, distribution, place of publication, the scrutinizer who checked it and the source it comes from; its GBIF key, and the iNaturalist, WoRMS or ITIS records COL names for it, as cross-references; its parent, accepted name and synonyms related.

A search of names, with its total.

Which release: the latest eXtended Release by default (3LXR, ChecklistBank's alias), the one GBIF builds on; 3LR for the Base Release, or a release's number. No key; one call a taxon.

const BASE_URI = 'https://api.checklistbank.org/'

const LATEST_XR = '3LXR'

The latest eXtended Release (ChecklistBank's alias).

const GBIF_RELEASE = '315557'

The release GBIF's taxonomy was built from (ChecklistBank 315557, COL26.6 XR of 2026-06-19, GBIF's dataset 7ddf754f-...: its endpoint on 2026-10-15).

const MAX_PER_PAGE = 1000

ColSource::__construct()

public function __construct(HttpClientInterface $http, readonly string $dataset = self::LATEST_XR, readonly ?string $language = 'eng', string $baseUri = self::BASE_URI, array $headers = [], float $throttle = 0.0)

$dataset

the ChecklistBank dataset: 3LXR (the latest XR), 3LR (the latest Base Release), or a release's number

$language

the vernacular names put first (ISO 639-3); null: COL's order

ColSource::getName()

public function getName(): string

ColSource::capabilities()

public function capabilities(): array

ColSource::entity()

public function entity(Identifier|string $id): ?Entity

A taxon or a synonym by its COL id (4CGXP, col:4CGXP, its page on catalogueoflife.org or checklistbank.org), by a GBIF key of the new form (gbif:4CGXP: the same id; a legacy number is the Backbone's, not COL's), or by its exact scientific name (the accepted usage first). One call, two for a name. A synonym is itself, its accepted taxon related.

ColSource::search()

public function search(Query $query): Page

ChecklistBank's search of the release's names (scientific, and the vernacular names it indexes), its order, page by offset, its total. A domain other than taxonomy answers nothing.

ColSourceFactory class

final class ColSourceFactory extends SourceFactory ColSourceFactory.php:21

The Catalogue of Life (ChecklistBank): taxa and synonyms by COL id, GBIF key or name, and a search of names - no key needed.

options: mailto: 'support@glitchr.io' # in the User-Agent dataset: 3LXR # the latest eXtended Release (GBIF's base); 3LR the Base Release; 315557 the release GBIF runs; any release's number language: eng # the vernacular names put first (ISO 639-3); null: COL's order throttle: 0 # seconds between two calls: ChecklistBank publishes no rate base_uri: 'https://api.checklistbank.org/'

Options