# Miex Solutions API

## Docs

- [Cancel Order](https://docs.miex.solutions/api-reference/cancel-order.md): Cancels an order that is in a cancellable state (`ORDERINIT` or `CLIENTPAYMENTWAIT`). The order must belong to the API key's user scope.
- [Create API Key](https://docs.miex.solutions/api-reference/create-api-key.md): Creates a new partner API key. The response includes the `rawKey` — **it is shown only once**. Store it securely. Requires staff JWT authentication.
- [Create Client](https://docs.miex.solutions/api-reference/create-client.md): Creates a new client user account. The client is associated with the API key's exchange scope.
- [Create Order](https://docs.miex.solutions/api-reference/create-order.md): Creates a client exchange order. The order is scoped to the exchanges accessible by the API key. Status begins at `ORDERINIT`.
- [Create Webhook](https://docs.miex.solutions/api-reference/create-webhook.md): Registers a new webhook endpoint. The response includes the `secretKey` for HMAC-SHA256 signature verification — **it is shown only once**. Store it securely.
- [Delete Webhook](https://docs.miex.solutions/api-reference/delete-webhook.md): Permanently removes a webhook endpoint. Pending deliveries for this webhook will be abandoned.
- [Get Client](https://docs.miex.solutions/api-reference/get-client.md): Returns client profile information for the given user ID.
- [Get Exchange](https://docs.miex.solutions/api-reference/get-exchange.md): Returns full public data for a specific exchange office by its numeric ID.
- [Get Order](https://docs.miex.solutions/api-reference/get-order.md): Returns full details for a specific order. The order must belong to the API key's user scope.
- [Get Order by Hash](https://docs.miex.solutions/api-reference/get-order-by-hash.md): Retrieves a public order view by its hashed ID. Useful for sharing order status with clients via a link without exposing the internal numeric ID.
- [List API Keys](https://docs.miex.solutions/api-reference/list-api-keys.md): Returns all API keys owned by the authenticated staff user. The raw key value is never returned — only the prefix and metadata.
- [List Exchanges](https://docs.miex.solutions/api-reference/list-exchanges.md): Returns all exchange offices accessible by the API key, including their schedules and public metadata.
- [List Offers](https://docs.miex.solutions/api-reference/list-offers.md): Returns paginated exchange rate offers (currency pairs and rates) available to clients.
- [List Orders](https://docs.miex.solutions/api-reference/list-orders.md): Returns a paginated list of orders associated with the API key's user scope.
- [List Webhooks](https://docs.miex.solutions/api-reference/list-webhooks.md): Returns all webhook endpoints registered for the authenticated API key's user scope. The `secretKey` is **not** returned in list responses.
- [Estimate Exchange](https://docs.miex.solutions/api-reference/public-estimate.md): Calculates the estimated source or destination amount for a given currency pair and exchange. Uses the same rate logic as order creation.
- [List Public Currencies](https://docs.miex.solutions/api-reference/public-list-currencies.md): Returns all distinct currencies from active offers across the branch's exchanges.
- [List Public Exchanges](https://docs.miex.solutions/api-reference/public-list-exchanges.md): Returns all exchange offices belonging to the API key's branch, including contacts and schedules. Accessible with any key type (pk_, sk_branch_, sk_personal_).
- [List Public Rates](https://docs.miex.solutions/api-reference/public-list-rates.md): Returns exchange rates (sale/buy) for active offers in the branch. Optionally filter by exchange ID.
- [Revoke API Key](https://docs.miex.solutions/api-reference/revoke-api-key.md): Permanently revokes an API key. All requests using this key will immediately receive 401. This action cannot be undone.
- [Update API Key](https://docs.miex.solutions/api-reference/update-api-key.md): Updates the name or `isActive` status of an API key. Deactivating a key (`isActive: false`) immediately rejects all requests authenticated with it.
- [Update Client](https://docs.miex.solutions/api-reference/update-client.md): Partially updates a client's profile fields. Only provided fields are updated.
- [Authentication](https://docs.miex.solutions/authentication.md): Authenticate Partner API requests using API keys.
- [Error Reference](https://docs.miex.solutions/errors.md): Standard error format and HTTP status codes returned by the Partner API.
- [Introduction](https://docs.miex.solutions/introduction.md): Integrate live exchange rates, order management, and client flows directly into your CRM, Telegram bot, or marketing platform.
- [Rate Limits](https://docs.miex.solutions/rate-limits.md): Understand the Partner API rate limits and how to handle 429 responses.
- [Webhooks](https://docs.miex.solutions/webhooks.md): Receive real-time notifications when orders and offers change.

## OpenAPI Specs

- [openapi](https://docs.miex.solutions/openapi.json)