# Coinlayer: agents start here

Steps for AI coding agents that add Coinlayer to a project.

## 1. Get an API key

A person creates the account: an agent cannot sign up. Sign up at https://app.apilayer.com/signup/coinlayer/free?utm_source=productpage_coinlayer&utm_medium=internal and subscribe to Coinlayer. The Free plan includes 100 requests / month and needs no credit card.

Copy the API key from the APILayer dashboard and give it to the agent as an environment variable (step 2).

## 2. Keep the key out of code

Read the key from an environment variable named `APILAYER_ACCESS_KEY`. Do not write the key into source code, commit it to git, or paste it into a chat.

Call Coinlayer from server code. The key travels in the request URL, so a request sent from a browser shows the key to every visitor.

```
# add .env to .gitignore
APILAYER_ACCESS_KEY=your_api_key
```

## 3. Make the first request

- Base URL: `https://api.coinlayer.com`
- Auth: `access_key` query parameter
- Formats: JSON, JSONP
- Endpoints:
  - `/live` Live rates
  - `/list` List

```sh
curl "https://api.coinlayer.com/live?access_key=$APILAYER_ACCESS_KEY"
```

## 4. Check the plan before you use a feature

Each plan adds features to the plan before it. Check that the account's plan includes a feature before writing code that uses it.

| Plan | Requests / month | Adds |
|---|---|---|
| Free | 100 | Update frequency: Hourly, Historical data, Target currencies: USD only, Usage: Non-commercial, SSL encryption |
| Starter | 5,000 | Target currencies: All, Usage: Commercial, Extended results, Conversion endpoint |
| Professional | 30,000 | Update frequency: 10-minute, Time-frame endpoint |
| Enterprise | 100,000 | Update frequency: 60-second, Change data |

Prices: https://apilayer.com/products/coinlayer/#pricing

## 5. Use the machine-readable docs

- Coinlayer documentation: https://docs.apilayer.com/apilayer/docs/coinlayer?utm_source=productpage_coinlayer&utm_medium=internal
- APILayer llms.txt: https://apilayer.com/llms.txt
