Getting Started: Using Authentication

Obtaining a token

Standard and Premium plans enjoy additional benefits such as higher API call volume (number of calls allowed per month), higher API call rate (number of calls allowed per minute) and more. See the pricing page for more information. To join a plan, visit our shop.

When you subscribe you will receive an email with your API token. This is a short random string consisting of letters, numbers and symbols. Keep this token secret and safe as there is no way to download it again. If it is lost or stolen, contact Echidna Support to have it invalidated and replaced.

Using the token

Set the token in the Authorization header of your requests to receive prioritised responses, increased volumes and rates according to your plan, e.g.:

curl -X GET -H 'Authorization: Bearer es_1a2b3c_314159265358979323846' \

    'https://echidna.fhir.org/r5/CodeSystem/$lookup?system=https://fhir-terminology.ohdsi.org&code=44054006'