Skip to main content
GET
Read finalized builder settlement history
Build a builder earnings or swap-history view from finalized settlements. Each entry includes the transaction hash, traded tokens, input/output amounts and separate Route and builder fees.
Pass nextCursor as cursor until it is null, even when a page has no settlements. totalsByToken covers the current page only, in token base units. Keep different tokens separate when adding totals. Authentication · Builder integration

Authorizations

x-api-key
string
header
required

Server-side key created in an authenticated developer workspace. Builder codes are public attribution, not credentials.

Query Parameters

code
string
required
Pattern: ^[A-Za-z0-9_-]{3,32}$
cursor
string
Maximum string length: 1500

Response

Verified registry or finalized history result

code
string
required
Pattern: ^[A-Za-z0-9_-]{3,32}$
builderId
string
required
Pattern: ^0x[0-9a-fA-F]{64}$
settlements
object[]
required
nextCursor
string | null
required
finalizedThrough
string
required
Pattern: ^[0-9]+$
totalsByToken
object[]
required
totalsScope
string
required
Allowed value: "page"
scannedFrom
string
Pattern: ^[0-9]+$
scannedThrough
string
Pattern: ^[0-9]+$
snapshotHash
string
Pattern: ^0x[0-9a-fA-F]{64}$