Skip to main content
GET
Get collateral reduction

Authorizations

Authorization
string
header
required

Scoped API key from the Totalis app settings. 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.

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])$
job_id
string<uuid>
required

Collateral-reduction job ID returned when the job was created.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

The job, with its own status reported separately from the on-chain operation that applies it and that operation's chain evidence.

job_id
string<uuid>
required

ID of the collateral-reduction job.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
maker_id
string<uint64-decimal>
required

Maker whose collateral requirement the job reduces.

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

QUEUED: waiting until the maker is eligible for a reduction; SOLVING: computing the requirement; NO_IMPROVEMENT: no lower requirement found, nothing to submit; DURABLE: certificate signed and ATTEST operation stored; FAILED: ended without a certificate.

Available options:
QUEUED,
SOLVING,
NO_IMPROVEMENT,
DURABLE,
FAILED
snapshot_block
string<uint64-decimal> | null
required

HyperEVM block of the maker's open-book snapshot; null until the snapshot is taken.

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])$
catalog_generation
string<uint64-decimal> | null
required

Market-catalog generation the snapshot is bound to; null until the snapshot is taken.

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])$
gross0
string<uint128-decimal> | null
required

Gross collateral requirement of the snapshot book in atomic USDC (6 decimals); null until the snapshot is taken.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
risk0
string<uint128-decimal> | null
required

Proven worst-case requirement of the snapshot book in atomic USDC (6 decimals); null until solved.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
turnover0
string<uint128-decimal> | null
required

Maker's settled turnover at the snapshot in atomic USDC (6 decimals), as signed into the certificate; null until the snapshot is taken.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
nonce
string<uint256-decimal> | null
required

Attestor nonce signed into the certificate; null without a certificate.

Maximum string length: 78
Pattern: ^(0|[1-9][0-9]*)$
expiry
string<uint64-decimal> | null
required

Certificate expiry in Unix seconds, two minutes after signing; null without a certificate.

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])$
digest
string | null
required

EIP-712 Attestation digest the attestor signed; null without a certificate.

Pattern: ^0x[0-9a-f]{64}$
operation_id
string | null
required

Maker-owned ATTEST operation that carries the certificate on chain; null without a certificate.

Pattern: ^0x[0-9a-f]{64}$
operation_status
enum<string> | null
required

Current status of the ATTEST operation; null without one.

Available options:
QUEUED,
IN_FLIGHT,
RETRYABLE,
UNKNOWN,
COMMITTED,
REVERTED,
EXPIRED_UNEXECUTED
transaction
object | null
required

Exact zero-value call for the maker to sign with its own gas account and submit through the self-funded transaction endpoint; null unless the operation is DURABLE and the certificate unexpired.

failure_code
string | null
required

Machine-readable reason the job failed, e.g. COOLDOWN_CHANGED; null otherwise.

Maximum string length: 64
next_eligible_at
string<date-time>
required

Earliest RFC 3339 UTC time the maker's next reduction can land on chain; the job stays QUEUED until then.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$
created_at
string<date-time>
required

RFC 3339 UTC time the job was created.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$
updated_at
string<date-time>
required

RFC 3339 UTC time the job last changed.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$