The Enigma API allows users to download datasets, query metadata, or perform server side operations on tables in Enigma. All calls to the API are made through a RESTful protocol and require an API key. The Enigma API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
To receive an API key, please contact your Enigma sales representative, or send an email to email@example.com
The general syntax for the api is as follows:
All of the data in Enigma is addressable through a datapath syntax. Datapaths work like URI addresses and can refer either to specific data tables or to parent nodes under which data tables are organized. Parent nodes contain metadata and contextual information about the children data tables organized under them.
The first two example datapaths (right) refer to specific tables in Enigma. They share three parent datapaths in common – us, us.gov, and us.gov.whitehouse. Parent datapaths are not tables, but rather organizing nodes or database names that refer to the places in the real world where particular datasets come from.
In the example above, both tables are from the United States, from the United States' Federal Government, and from the United States' Federal Government's White House. Each of those parent nodes have metadata associated with them that describe what they are and what children tables they contain. API users can issue a /meta/ query to retrieve metadata for any datapath, while /data/ queries return results for table datapaths only.