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

# Introduction

**Version:** 1.3\
**OpenAPI Version:** 3.1.0

### Overview

The JMYR Zetrix BaaS API provides a compact integration layer for wallet management, JMYR ZTP20 token operations, transaction signing and submission, smart contract interaction, and paymaster-sponsored contract execution on the Zetrix blockchain.

This API is designed for application teams that need to:

* create and manage Zetrix wallet accounts
* query native ZETRIX and JMYR token balances
* generate unsigned transaction blobs for token transfers and contract calls
* sign and submit transactions to the Zetrix network
* query transaction execution status
* invoke smart contracts with either user-paid gas or paymaster-sponsored gas

### Environments

| Environment | Base URL                         |
| ----------- | -------------------------------- |
| Testnet     | `https://api-sandbox.zetrix.com` |
| Mainnet     | `http://api-v2.zetrix.com`       |

### **Authorization**

All API requests must include **both** the API Gateway key and the access token:

* **API Gateway Key:** Include in the header `X-API-Key`.
* **Access Token:** Include in the header `Authorization: Bearer <access_token>`.

**Access Token**

```bash
Authorization : Bearer <ACCESS_TOKEN>
```

**API Gateway Authentication**

All requests to the Zetrix API Gateway **must** include the following header:

**Testnet**

```bash
X-API-Key:ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
```

**Mainnet**

```bash
X-API-Key:OOXtr6biOR6eJa2Rjj9En4PwDxxl0U2haUohaxrC
```

**Example (curl)**

```bash
curl -X GET https://<api-endpoint> \
  -H "X-API-Key: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json"
```

**Notes**

* The `X-API-Key` header is **required** for all API Gateway requests.
* Requests without a valid API key will be rejected with an authorization error.

### Response Format

Most endpoints return a common wrapper with the following top-level fields:

| Field       | Type    | Description                                               |
| ----------- | ------- | --------------------------------------------------------- |
| `success`   | boolean | Indicates whether the request was processed successfully. |
| `object`    | varies  | The endpoint-specific payload.                            |
| `messages`  | array   | Informational, warning, or error messages.                |
| `timestamp` | string  | Response timestamp in ISO date-time format.               |
| `traceId`   | string  | Correlation identifier for request tracing.               |

Message entries may contain:

* `type`: `INFO`, `ERROR`, or `WARNING`
* `errorCode`: numeric error code when applicable
* `message`: human-readable detail