Ezys Documentation

Appearance

API Reference

Authentication ​

How to authenticate with the EZYS API.

API Key ​

All API requests require a valid API key, passed via the X-API-Key header.

http
X-API-Key: {your_api_key}

Example ​

bash
curl -X POST "https://api.ezys.io/v1/quotes" \
  -H "X-API-Key: {your_api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "RFQ-001", "actorId": "acme", "source": "USDC", "target": "KRW", "amount": "1000", "side": "sell" }'

Authentication Errors ​

Missing API Key ​

http
HTTP/1.1 401 Unauthorized

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key is required"
  }
}

Invalid API Key ​

http
HTTP/1.1 401 Unauthorized

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}

Disabled API Key ​

http
HTTP/1.1 403 Forbidden

{
  "success": false,
  "error": {
    "code": "API_KEY_DISABLED",
    "message": "This API key has been disabled"
  }
}

Key Rotation ​

When rotating keys, a new key can be issued while the existing key remains active, allowing for zero-downtime migration. Once the new key is deployed, the previous key can be deactivated.