{ "openapi": "3.1.0", "info": { "title": "Legend Trading API", "version": "1.0.0", "description": "Trade using an account-scoped API key. The account owner signs a grant binding the key hash, scopes, network and service audience; keys remain valid until revoked. Keys cannot withdraw or transfer assets. Orders use decimal strings; IOC limit orders express market execution with an explicit price bound. No preview or trade-intent step is required. Exchange constraints still apply. Revocation stops future API actions and does not cancel existing orders." }, "servers": [ { "url": "https://app.legend.trade/api/trading", "description": "Production" } ], "security": [ { "tradingKey": [] } ], "components": { "securitySchemes": { "tradingKey": { "type": "http", "scheme": "bearer", "bearerFormat": "lg_trade_<64 hex characters>" } } }, "paths": { "/v1/api-keys": { "post": { "operationId": "registerApiKey", "summary": "Register a wallet-signed API grant", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "consent": { "type": "object", "properties": { "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "key_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "policy": { "type": "object", "properties": { "scopes": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "string", "enum": [ "trading:read", "trading:write" ] } } }, "required": [ "scopes" ], "additionalProperties": false }, "issued_at": { "type": "integer", "exclusiveMinimum": 0, "maximum": 8640000000000000 }, "expires_at": { "default": null, "type": "null" } }, "required": [ "account", "network", "key_hash", "policy", "issued_at" ], "additionalProperties": false }, "signature": { "type": "string", "pattern": "^0x[a-fA-F0-9]{130}$" } }, "required": [ "consent", "signature" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "api_key" }, "account": { "type": "string" }, "network": { "type": "string" }, "key_hash": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "account", "network", "key_hash", "scopes", "expires_at" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/api-keys/revoke": { "post": { "operationId": "revokeApiKey", "summary": "Revoke a key with the account owner signature, including before registration", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "signature": { "type": "string", "pattern": "^0x[a-fA-F0-9]{130}$" } }, "required": [ "account", "key_hash", "signature" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "api_key" }, "key_hash": { "type": "string" }, "revoked": { "type": "boolean", "const": true } }, "required": [ "object", "key_hash", "revoked" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/orders": { "post": { "operationId": "createOrder", "summary": "Place an order", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false } }, "required": [ "account", "market", "side", "size", "price" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } }, "get": { "operationId": "listOrders", "summary": "List API order history, or current account orders with status=open", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "const": "open" } }, { "name": "dex", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 100 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "list" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } }, "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "data", "has_more", "next_cursor" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/orders/{id}": { "get": { "operationId": "retrieveOrder", "summary": "Retrieve and reconcile an order", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "pattern": "^\\d{1,16}$" } ] } } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/orders/{id}/modify": { "post": { "operationId": "modifyOrder", "summary": "Modify order price, size, or trigger", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "pattern": "^\\d{1,16}$" } ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "always_place": { "type": "boolean" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/orders/{id}/cancel": { "post": { "operationId": "cancelOrder", "summary": "Cancel an open order", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "string", "pattern": "^\\d{1,16}$" } ] } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": {}, "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "order" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "time_in_force": { "default": "gtc", "type": "string", "enum": [ "gtc", "ioc", "alo" ] }, "reduce_only": { "default": false, "type": "boolean" }, "trigger": { "type": "object", "properties": { "price": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "kind": { "type": "string", "enum": [ "take_profit", "stop_loss" ] }, "market": { "type": "boolean" } }, "required": [ "price", "kind", "market" ], "additionalProperties": false }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "status": { "type": "string", "enum": [ "processing", "open", "filled", "canceled", "rejected", "unknown", "waiting_for_trigger" ] }, "exchange_order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filled_size": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "average_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "object", "account", "market", "side", "size", "price", "time_in_force", "reduce_only", "network", "status", "exchange_order_id", "filled_size", "average_price", "error", "created_at" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/account": { "get": { "operationId": "retrieveAccount", "summary": "Read account balances", "parameters": [], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "account" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "network": { "type": "string", "enum": [ "hyperliquid_testnet", "hyperliquid_mainnet" ] }, "equity": { "type": "string" }, "withdrawable": { "type": "string" }, "margin_used": { "type": "string" }, "perpetuals": { "type": "array", "items": { "type": "object", "properties": { "dex": { "type": "string" }, "equity": { "type": "string" }, "withdrawable": { "type": "string" }, "margin_used": { "type": "string" } }, "required": [ "dex", "equity", "withdrawable", "margin_used" ], "additionalProperties": false } }, "spot": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string" }, "total": { "type": "string" }, "held": { "type": "string" } }, "required": [ "token", "total", "held" ], "additionalProperties": false } } }, "required": [ "object", "account", "network", "equity", "withdrawable", "margin_used", "perpetuals", "spot" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/positions": { "get": { "operationId": "listPositions", "summary": "Read positions across supported DEXes or filter by DEX", "parameters": [ { "name": "dex", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 100 } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "list" }, "data": { "type": "array", "items": { "type": "object", "properties": { "market": { "type": "string" }, "size": { "type": "string" }, "entry_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "liquidation_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "unrealized_pnl": { "type": "string" }, "leverage": { "type": "number" }, "margin_type": { "type": "string", "enum": [ "cross", "isolated" ] } }, "required": [ "market", "size", "entry_price", "liquidation_price", "unrealized_pnl", "leverage", "margin_type" ], "additionalProperties": false } }, "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "data", "has_more", "next_cursor" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/fills": { "get": { "operationId": "listFills", "summary": "List account fills indexed by Legend", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "object": { "type": "string", "const": "list" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "market": { "type": "string" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string" }, "price": { "type": "string" }, "exchange_order_id": { "type": "string" }, "fee": { "type": "string" }, "fee_token": { "type": "string" }, "executed_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "id", "market", "side", "size", "price", "exchange_order_id", "fee", "fee_token", "executed_at" ], "additionalProperties": false } }, "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "object", "data", "has_more", "next_cursor" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/leverage": { "post": { "operationId": "updateLeverage", "summary": "Set leverage and margin type", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "leverage": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "margin_type": { "type": "string", "enum": [ "cross", "isolated" ] } }, "required": [ "market", "leverage", "margin_type" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/margin": { "post": { "operationId": "updateMargin", "summary": "Add or remove isolated margin", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "amount": { "type": "string", "pattern": "^-?(0|[1-9]\\d{0,9})(\\.\\d{1,6})?$" } }, "required": [ "market", "amount" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/twaps": { "post": { "operationId": "createTwap", "summary": "Create a native Hyperliquid TWAP", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "size": { "type": "string", "maxLength": 40, "pattern": "^(0|[1-9]\\d{0,17})(\\.\\d{1,18})?$" }, "duration_minutes": { "type": "integer", "minimum": 5, "maximum": 10080 }, "randomize": { "default": false, "type": "boolean" }, "reduce_only": { "default": false, "type": "boolean" } }, "required": [ "market", "side", "size", "duration_minutes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/twaps/cancel": { "post": { "operationId": "cancelTwap", "summary": "Cancel a native Hyperliquid TWAP", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key per logical action. Reuse it only with the same action and parameters. Never blindly resubmit an unknown execution under a new key. Unrelated actions may use their own keys while that outcome remains unknown.", "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "market": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9@][a-zA-Z0-9@:_./-]*$" }, "twap_id": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "market", "twap_id" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Action result; inspect status for exchange rejection", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "202": { "description": "Execution outcome unknown. Retrieve the resource to reconcile; do not submit a replacement blindly.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/v1/operations/{id}": { "get": { "operationId": "retrieveOperation", "summary": "Retrieve an action result", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Result", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "object": { "type": "string", "const": "operation" }, "account": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "action": { "type": "string" }, "status": { "type": "string", "enum": [ "processing", "succeeded", "rejected", "unknown" ] }, "exchange_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "object", "account", "action", "status", "exchange_id", "error" ], "additionalProperties": false } } } }, "400": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "409": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Request throttled. Respect Retry-After and retry with the same idempotency key.", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds before retry" } } }, "503": { "description": "Request failed", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "type", "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } } } }