Skip to main content
GET
Get your BuilderCodes program configuration

Authorizations

X-Monaco-Signature
string
header
required

Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.

Response

OK

applicationId
string<uuid> | null

Application id derived from the authenticated session.

enrolled
boolean | null

Whether this application is currently enrolled in BuilderCodes.

payoutAddress
string | null

Current lowercase-normalized payout address, or null when none is configured.

Example:

"0x0000000000000000000000000000000000000001"

buildercodesEnabled
boolean | null

Whether the BuilderCodes revenue share is switched on. While false no new share accrues; balances already credited stay readable and claimable.

buildercodesBudgetBps
integer<uint32> | null

Target BuilderCodes share in basis points, computed from the fill's gross non-negative Monaco protocol take and capped by the remainder after Monaco's floor.

Required range: x <= 10000
Example:

1000

builderFeeEnabled
boolean | null

Whether builder fees are currently charged. While false, builderFeeBps is stored but no builder fee is charged.

builderFeeBps
integer<uint32> | null

This application's stored builder fee in basis points: the additional taker fee it charges its users. The fee charged is this value capped at builderFeeCapBps, and 0 while builderFeeEnabled is false or the application is not enrolled with a payout address.

Required range: x <= 100
Example:

10

builderFeeCapBps
integer<uint32> | null

The highest builder fee, in basis points, that can currently be set or charged.

Required range: x <= 100
Example:

100

changesRemaining
integer<uint32> | null

Builder-fee changes this application can still make in the current rolling 24 hours (at most 2).

Required range: x <= 2
Example:

2

nextChangeAllowedAt
string<date-time> | null

RFC 3339 time at which the next builder-fee change becomes allowed, or null while changesRemaining is above 0.