Welcome

Welcome to the Web Services of the Catalogue of Life. Here you can find information on which web services the Catalogue of Life offers, how you can subscribe to them, and the technical details of calling the web services from within your own application.

Subscribing

When calling our web services, your application must provide a key as part of the service URL. You can obtain a key by filling out the form below. Anyone can make use of the web services provided by the Catalogue of Life.

We need at least the domain from which you will be calling our services. The key will work for the domain you enter and all its subdomains. You can optionally provide us with an email address, so which can inform you about upcoming changes in the API, server malfunctions, etc. etc.

Your Domain *
Your Email

Description of currently available web services



Status of a scientific name in CoL



Input is a scientific name (a genus name, a species name (binomial) or an infra-species name (trinomial) and the output is an XML with the status of the provided name in the Catalog of Life and a list of related accepted names with all the available information about each name.

Input URL

http://<domain>/status/query/key/<generated_key>/genus/<genus_name>[/species/<species_name>[/infraspecies/<infraspecies_name>]][/version/<version_year>]

Parameters

  • status - mandatory, service name
  • query - mandatory, action name
  • key/<generated_key> - mandatory, generated key
  • genus/<genus_name> - mandatory
  • species/<species_name> - optional
  • infraspecies/<infraspecies_name> - optional, requires species parameter
  • version/<db_version> - optional, default latest (or last) version.

Examples

  • http://<domain>/status/query/key/123456/genus/Tabebuia
  • http://<domain>/status/query/key/123456/genus/Salinator/species/solida/version/2011
  • http://<domain>/status/query/key/123456/genus/Caryodes/species/dufresnii/infraspecies/superior/version/2011

XML Output

<?xml version='1.0' encoding='utf-8'?>
<sp2000>
  <request>
    <service id='status'>
      <description>Status of a scientific name in CoL</description>
      <parameters>
        <genus>Caryodes</genus>
        <species>dufresnii</species>
        <infraspecies>superior</infraspecies>
        <version>2011</version>
      </parameters>
      <date>09 Jun 2021 10:18:14 GMT</date>
  </request>
  <response>
    <status>accepted name|ambiguous synonym|misapplied name|privisionally accepted
name|synomym</status>

    <accepted_name id='1221'>
      <kingdom>       </kingdom>
      <phylum>       </phylum>
      <class>       </class>
      <order>       </order>
      <superfamily>       </superfamily>
      <family>       </family>
      <genus>       </genus>
      <subgenus>       </subgenus>
      <species>       </species>
      <infraspecies_marker>     </infraspecies_marker>
      <infraspecies>       </infraspecies>
      <author>       </author>
    </accepted_name>

    <accepted_name id='1222'>
      <kingdom>       </kingdom>
      <phylum>       </phylum>
      <class>       </class>
      <order>       </order>
      <superfamily>       </superfamily>
      <family>       </family>
      <genus>       </genus>
      <subgenus>       </subgenus>
      <species>       </species>
      <infraspecies_marker>     </infraspecies_marker>
      <infraspecies>       </infraspecies>
      <author>       </author>
    </accepted_name>
    
  </response>
  <status code='0'>Success</status>
  <status code='100'>Name not found</status>
  <status code='200'>Unable connect to the specified database</status>
  <status code='300'>Required parameters not specified</status>
  <status code='400'>Unable verify the validity of the key</status>
  <status code='500'>Invalid key</status>
  <status code='600'>[Generic error message]</status>
</sp2000>


Taxon synonyms query



Input is a scientific name (a genus name, a species name (binomial) or an infra-species name (trinomial) and the output is an XML with the status of the provided name and a list of related Accepted Names with all the information available about each one and a list of all synonyms for each Accepted Name.

Input URL

http://<domain>/synonyms/query/key/<generated_key>/genus/<genus_name>[/species/<species_name>[/infraspecies/<infraspecies_name>]][/version/<version_year>]

Parameters

  • synonyms - mandatory, service name
  • query - mandatory, action name
  • key/<generated_key> - mandatory, generated key
  • genus/<genus_name> - mandatory
  • species/<species_name> - optional
  • infraspecies/<infraspecies_name> - optional, requires species parameter
  • version/<db_version> - optional, default latest (or last) version.

Examples

  • http://<domain>/synonyms/query/key/123456/genus/Tabebuia
  • http://<domain>/synonyms/query/key/123456/genus/Salinator/species/solida/version/2011
  • http://<domain>/synonyms/query/key/123456/genus/Caryodes/species/dufresnii/infraspecies/superior/version/2011

XML Output

<?xml version='1.0' encoding='utf-8'?>
<sp2000>
  <request>
    <service id='synonyms'>
      <description>Taxon synonyms in CoL</description>
      <parameters>
        <genus>Caryodes</genus>
        <species>dufresnii</species>
        <infraspecies>superior</infraspecies>
        <version>2011</version>
      </parameters>
      <date>09 Jun 2021 10:18:14 GMT</date>
  </request>
  <response>
    <accepted_name id='23232'>
      <kingdom>       </kingdom>
      <phylum>       </phylum>
      <class>       </class>
      <order>       </order>
      <superfamily>       </superfamily>
      <family>       </family>
      <genus>       </genus>
      <subgenus>       </subgenus>
      <species>       </species>
      <infraspecies_marker>     </infraspecies_marker>
      <infraspecies>       </infraspecies>
      <author>       </author>

      <synonyms>
        <synonym id=''>
          <status></status>
      <kingdom>       </kingdom>
      <phylum>       </phylum>
      <class>       </class>
      <order>       </order>
      <superfamily>       </superfamily>
      <family>       </family>
      <genus>       </genus>
      <subgenus>       </subgenus>
      <species>       </species>
      <infraspecies_marker>     </infraspecies_marker>
      <infraspecies>       </infraspecies>
      <author>       </author>
        </synonym>
        ...
        <synonym id=''>
          <status></status>
      <kingdom>       </kingdom>
      <phylum>       </phylum>
      <class>       </class>
      <order>       </order>
      <superfamily>       </superfamily>
      <family>       </family>
      <genus>       </genus>
      <subgenus>       </subgenus>
      <species>       </species>
      <infraspecies_marker>     </infraspecies_marker>
      <infraspecies>       </infraspecies>
      <author>       </author>
        </synonym>
      </synonyms>
    </accepted_name>
    
  </response>
  <status code='0'>Success</status>
  <status code='100'>Name not found</status>
  <status code='200'>Unable connect to the specified database</status>
  <status code='300'>Required parameters not specified</status>
  <status code='400'>Unable verify the validity of the key</status>
  <status code='500'>Invalid key</status>
  <status code='600'>[Generic error message]</status>
</sp2000>


Taxon common names query



Input is a scientific name (a genus name, a species name (binomial) or an infra-species name (trinomial) and the output will be an XML with a list of common names associated with the scientific name.

Input URL

http://<domain>/common/query/key/<generated_key>/genus/<genus_name>[/species/<species_name>[/infraspecies/<infraspecies_name>]][/version/<version_year>]

Parameters

  • common - mandatory, service name
  • query - mandatory, action name
  • key/<generated_key> - mandatory, generated key
  • genus/<genus_name> - mandatory
  • species/<species_name> - optional
  • infraspecies/<infraspecies_name> - optional, requires species parameter
  • version/<db_version> - optional, default latest (or last) version.

Examples

  • http://<domain>/common/query/key/123456/genus/Tabebuia
  • http://<domain>/common/query/key/123456/genus/Salinator/species/solida/version/2011
  • http://<domain>/common/query/key/123456/genus/Caryodes/species/dufresnii/infraspecies/superior/version/2011

XML Output

<?xml version='1.0' encoding='utf-8'?>
<sp2000>
  <request>
    <service id='common'>
      <description>Taxon synonyms in CoL</description>
      <parameters>
        <genus>Caryodes</genus>
        <species>dufresnii</species>
        <infraspecies>superior</infraspecies>
        <version>2011</version>
      </parameters>
      <date>09 Jun 2021 10:18:14 GMT</date>
  </request>
  <response>
    <common id='12344'>
      <name>___________</name>
      <language>___________</language>
      <country>___________</country>
    </common>
    ...
    <common id=''>
      <name>___________</name>
      <language>___________</language>
      <country>___________</country>
    </common>
  </response>
  <status code='0'>Success</status>
  <status code='100'>Name not found</status>
  <status code='200'>Unable connect to the specified database</status>
  <status code='300'>Required parameters not specified</status>
  <status code='400'>Unable verify the validity of the key</status>
  <status code='500'>Invalid key</status>
  <status code='600'>[Generic error message]</status>
</sp2000>