Skip to content

Name resolution API (early public ALPHA)

dimus edited this page Mar 19, 2012 · 3 revisions

This API is in an early ALPHA stage. We do not guarantee it’s stability or performance. It might crash or go off-line for several hours without notice. Use the resolver API at your own risk and submit problems at it’s issue tracker. Some resource URLs or their parameters might get deprecated when API approaches a stable release.

Purpose

This API can be used to normalize a list of scientific names against one or more checklists. It will help to get answers to the following questions:

  • Is this string a scientific name
  • Is it spelled correctly
  • Is it a currently used scientific name?
  • Where this name is placed in a hierarchy?

Limits

One request can have up to 5000 name strings, compared against up to 5 data sources simultaneously.
Requests smaller than 500 name strings will be dealt with immediatelly, bigger requests will be sent to a que. In the later case you will receive a resource URL which can be used to check on the status of your request.

Workflow

  • Find a collection/collections of names strings you want to use for name resolution. Use Data Source Resource to find them.
  • Submit a query with a list of name strings to Name Resolver resource, and indicate IDs of data sources you want to use.

Data Source Resource URL:

http://resolver.globalnames.org/data_sources.xml (xml output)

http://resolver.globalnames.org/data_sources.json (json output)

http://resolver.globalnames.org/data_sources (html output)

Data Sources query Example

http://resolver.globalnames.org/data_sources.xml
http://resolver.globalnames.org/data_sources.xml

Name Resolver Resource URL:

http://resolver.globalnames.org/name_resolvers.xml (xml output)

http://resolver.globalnames.org/name_resolvers.json (json output)

http://resolver.globalnames.org/name_resolvers (html output)

Parameters for Name Resolver Resource:

Name resolver can be accessed in 3 different ways — using GET request, using POST request, or by uploading a file through multipart POST request.

names (only for GET requests)

takes a pipe-delimited list of name strings like: “Parus parus|Betula|Ursus arctos”