All registered users, whether on a free or paid plan, can use our Quickstart Guide to explore the full range of API functionalities with just one click.
- Existing users: Access the Quickstart Guide below.
- New users: Create an account and get started immediately.
Get onboarded with the Coinlayer API and start retrieving stock market data in just a few minutes!
If you’re ready to dive in immediately, follow these steps:
Step 1: Obtain your API Key
Sign up for a free or paid plan on the Coinlayer website. Once registered, you’ll find your unique API access key in your dashboard.
Step 2: Construct your first API request
The base URL for all requests is:
https://api.coinlayer.com/Add the desired endpoint (for example: live) and append your access_key.
Example:
https://api.coinlayer.com/live?access_key=YOUR_ACCESS_KEYStep 3: Inspect the JSON response
A typical successful response for the live endpoint might look like:
{
"success": true,
"terms": "https://coinlayer.com/terms",
"privacy": "https://coinlayer.com/privacy",
"timestamp": 1529571067,
"target": "USD",
"rates": {
"ADA": 0.160502,
"AE": 2.551479,
…
} }You’ll get a success flag, a timestamp, the target currency, and a rates object mapping symbols to values.
Step 4: Try additional endpoints
Coinlayer offers several endpoints for different use-cases:
live: Latest rateshistorical: Rates on a specified dateconvert: Convert between currenciestimeframe: Time-series data over a periodchange: Fluctuation/change data over a periodlist: A list of supported cryptocurrencies and fiat currencies