Quickstart Guide

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.

Get free API Access Key

Step 2: Construct your first API request

The base URL for all requests is:

Add the desired endpoint (for example: live) and append your access_key.

Example:

Step 3: Inspect the JSON response

A typical successful response for the live endpoint might look like:

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 rates
• historical: Rates on a specified date
• convert: Convert between currencies
• timeframe: Time-series data over a period
• change: Fluctuation/change data over a period
• list: A list of supported cryptocurrencies and fiat currencies