> For the complete documentation index, see [llms.txt](https://docs.1keeper.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.1keeper.com/1keeper-open-api/getting-started.md).

# Getting Started

## Getting Started

### Base URL

The production base URL should be provided by the 1Keeper team.

```
https://<your-1keeper-api-domain>
```

{% hint style="warning" %}
Replace the placeholder base URL with the actual production or staging domain before publishing externally.
{% endhint %}

### Protocol

* Transport: `HTTPS`
* Content type: `application/json`
* Encoding: `UTF-8`
* HTTP method: `POST` unless otherwise specified

### Authentication

All endpoints require `api_key` in the request body.

Example:

```json
{
  "api_key": "ak_xxxxxxxxxxxxxxxx"
}
```

### Rate Limits

* Default limit: `1 request per second` per endpoint, per IP
* Throttled response: `429 Too Many Requests`

### Common Headers

Recommended headers:

```http
Content-Type: application/json
Accept: application/json
```

### Common Response Format

Typical success response:

```json
{
  "code": 10000,
  "message": "ok",
  "data": {}
}
```

### Common Response Fields

| Field     | Type                  | Description                                                                                       |
| --------- | --------------------- | ------------------------------------------------------------------------------------------------- |
| `code`    | int                   | Business status code. `10000` means success.                                                      |
| `message` | string                | Response message.                                                                                 |
| `data`    | object / array / null | Business payload. Shape depends on the endpoint. Some endpoints may omit `data` or return `null`. |

### Common Status Codes

| Code    | Message             | Description         |
| ------- | ------------------- | ------------------- |
| `10000` | `ok`                | Request succeeded   |
| `429`   | `Too Many Requests` | Rate limit exceeded |

### Common Enums

#### `chain_id`

| Value | Network |
| ----- | ------- |
| `501` | Solana  |
| `56`  | BSC     |

#### `trade_side`

| Value | Meaning |
| ----- | ------- |
| `1`   | Buy     |
| `2`   | Sell    |

#### `network`

| Value    | Meaning        |
| -------- | -------------- |
| `solana` | Solana network |
| `bsc`    | BSC network    |

#### `timeframe`

| Value    | Meaning        |
| -------- | -------------- |
| `minute` | Minute candles |
| `hour`   | Hour candles   |
