Skip to main content
POST

Authorizations

x-partner-api-key
string
header
required

The client's own API key (kmi_<id>_<secret>), issued by Kamui. A missing, malformed, unknown, revoked or expired key answers 401 unauthorized.

Headers

x-request-id
string

Your id for this request: 1 to 128 letters, digits, ., _, : or -. It is echoed in the response. Any other value is replaced with a new UUID.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Body

application/json
address
string
required

Ethereum address: 0x and 40 hex characters, in lowercase or with a valid EIP-55 checksum. Other mixed case, all-uppercase hex, a 0X prefix and the zero address answer 400.

Required string length: 42
Pattern: ^0x[0-9a-fA-F]{40}$
slug
string

Vault slug, matched exactly: lowercase letters, digits and single hyphens (stable-vault). Case and whitespace count, so Stable-Vault and stable-vault answer 400. A legacy slug works; the response carries the canonical one.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
types
enum<string>[]
Required array length: 1 - 8 elements
Available options:
DEPOSIT,
DEPOSIT_REQUEST,
DEPOSIT_CLAIM,
DEPOSIT_CANCEL,
REDEEM_REQUEST,
REDEEM_CANCEL,
WITHDRAW,
WITHDRAW_INSTANT
limit
integer
Required range: 1 <= x <= 100
cursor
string

The previous page's nextCursor, unchanged. It is opaque and signed: a changed cursor, or one sent with another address, slug or types, answers 400 invalid_cursor.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_-]+$

Response

Success

data
object
required
asOf
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991