Republic of Colombia's coat of arms
Accessibility Panel
You are in:  Home  /  API



API


The catalog offers the information through an RESTful API with JSON responses. It is version 1, open to the entire community without restriction and is considered stable for use. Technical information of the api can be consulted in this link.

Access is through the URL: http://catalogopecesdecolombia.unal.edu.co/results/api/v1/species/{Species name or URN}, where the species name may contain spaces or the + symbol as a replacement for the space, for example:

The API also receives URNs from pages such as WORMS, ZooBank y Catalogue of Life, for example:

Finally, the API supports two languages. By default the information is in Spanish (es), but if you want the information in English (en) you can add the language in the URL, for example:

The API returns data in json format and the field names are in English and lowercase, NULL in the context is considered empty text and the information according to the api URL is in Spanish or English.

Field Type Description
lsid Text URN of WORMS, ZooBank or Catalog of life assigned to the species in the catalog
species Text or NULL Species name
author Text Author
genus Text Species genus
basins JSON Subject with 0 to N basins
representative Text or NULL List of representative specimen
diagnosticChar Text or NULL External characteristics that allow rapid identification of the species by experts and nonexperts
establishment Text or NULL Species oigin
uicn Text or NULL Threat category according to UICN for the region
nationalRiskCategory Text or NULL National threat category
uses JSON Subject with 0 to N uses
trophicGuilds JSON Subject with 0 to N trophic guilds
reproductiveMode Text or NULL Reproduction mode
timeStampCreated Text or NULL Date of entry of the record into the catalog database in ISO format 8601 [YYYY-MM-DD]
timeStampModified Text or NULL Date of record update to the catalog database in ISO 8601 format [YYYYY-MM-DD]