Skip to main content
GET
Get maker withdrawal

Authorizations

Authorization
string
header
required

Scoped API key (ttk_...), created in the Totalis app or by a wallet-session user through the API keys routes with a fresh wallet signature; those routes never accept a key. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires. Send no Origin.

Path Parameters

maker_id
string<uint64-decimal>
required

On-chain maker ID, as a decimal string. The credential must be authorized for this maker. Never 0.

Maximum string length: 20
Pattern: ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$

Response

The maker's withdrawal schedule as the projection last saw it. Your maker wallet sends requestMakerWithdraw, executeMakerWithdraw and cancelMakerWithdraw itself and pays the gas in HYPE; Totalis never relays or sponsors them. The amount a new request may ask for is the MAKER_WITHDRAW action in Get maker capital. Read this again after each call your wallet sends: none of them has a stream event of its own.

maker_id
string<uint64-decimal>
required

Maker this withdrawal schedule belongs to.

Maximum string length: 20
Pattern: ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$
controller
string
required

Maker wallet: the only wallet that can request, execute or cancel a withdrawal (requestMakerWithdraw, executeMakerWithdraw, cancelMakerWithdraw). It sends each call itself and pays the gas in HYPE.

Pattern: ^0x[0-9a-f]{40}$
pending
object | null
required

The live withdrawal request, or null when none is pending. A maker has at most one: a new request reverts until this one executes or is cancelled.

as_of_block
string<uint64-decimal>
required

Last HyperEVM block the projection behind this read has processed.

Maximum string length: 20
Pattern: ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$
status
enum<string>
required

CURRENT when the projection is caught up with the chain; STALE when it lags, so a recent request, execute or cancel may not show yet.

Available options:
CURRENT,
STALE