# Daily Emission API v1

## Getting Started

#### **Base URL** <a href="#base-url" id="base-url"></a>

```
https://api.unlocks.app
```

#### **Authentication** <a href="#authentication" id="authentication"></a>

Provide your api key in the `x-api-key` header.

```
GET https://api.unlocks.app/v1/daily-emission
HEADER: x-api-key: <YOUR_API_KEY>
```

**Parameters**

Note: `tokenID` needs to be specified.

* tokenId (required): Get `tokenId` from [Token List API](https://docs.unlocks.app/api-documents/api-endpoints/token-list-api)
* start (optional): The start date for time filtering in the format YYYY-MM-DD. Defaults to the earliest available date.
* end (optional):   The end date for time filtering in the format YYYY-MM-DD. Defaults to the current date.

**Get Specific Date Range Example:**

Replace the preferred start and end dates in indicated format.

```
curl -X 'GET' \
  'https://api.unlocks.app/v1/daily-emission?tokenId=arbitrum&start=YYYY-MM-DD&end=YYYY-MM-DD' \
  -H 'x-api-key: $YOUR_API_KEY'
```

**Get Full Data Range Example:**

Remove date completely to call the full range.

```
curl -X 'GET' \
  'https://api.unlocks.app/v1/daily-emission?tokenId=arbitrum' \
  -H 'x-api-key: $YOUR_API_KEY'
```

**Response**

```json
{
    "metadata": {
        "queryDate": "2024-08-20T04:53:46Z"
    },
    "status": true,
    "data": [
        {
            "startDate": "2024-08-20T00:00:00Z",
            "endDate": "2024-08-21T00:00:00Z",
            "tokenName": "Arbitrum",
            "tokenSymbol": "ARB",
            "unlockAmount": 478781.65092402464,
            "unlockValue": 259053.43030216015,
            "referencePrice": 0.541068,
            "allocations": [
                {
                    "allocationName": "Arbitrum DAO Treasury",
                    "standardAllocationName": "Reserve",
                    "unlockAmount": 478781.65092402464,
                    "unlockValue": 259053.43030216015
                }
            ],
            "totalCumulativeUnlockedAmount": 3259930660.716421
        },
        ....
    ]
}

```

The response includes time series data with the date (in UTC timezone), with granularity at the level of day.

**Return Fields Explanation**

| Fields                        | Data Type    | Description                                                 |
| ----------------------------- | ------------ | ----------------------------------------------------------- |
| startDate                     | timestamp    | Start date of the aggregated emission                       |
| endDate                       | timestamp    | End date of the aggregated emission                         |
| tokenName                     | string       | Token name                                                  |
| tokenSymbol                   | string       | Token symbol                                                |
| unlockAmount                  | number       | Total Unlock amount in date period                          |
| unlockValue                   | number       | Total unlock value in date period                           |
| referencePrice                | number       | Reference price for unlockValue calculation                 |
| allocations                   | object array |                                                             |
| totalCumulativeUnlockedAmount | number       | Total unlocked amount from token TGE till specified endDate |

**Return Fields Explanation: Allocations**

| Fields                 | Data Type | Description                            |
| ---------------------- | --------- | -------------------------------------- |
| allocationName         | string    | Allocation name                        |
| standardAllocationName | string    | Standard allocation of this allocation |
| UnlockedAmount         | number    | Total Unlock amount in date period     |
| UnlockedValue          | number    | Total unlock value in date period      |