flint.margin.maker.v1 reference
Table of Contents
Top
flint/margin/maker/v1/auth/messages.proto
AuthenticateRequest
Field Type Label Description pubkey string Base58 public key. signature string Base58 signature over the domain prefix and nonce returned by Challenge. trader_id TraderId Account to scope the session to. Omit to select the lowest authorized ID.
AuthenticateResponse
Field Type Label Description session_token string Send as authorization: Bearer <session_token> metadata. trader_ids TraderId repeated Accounts controlled as owner or active TRADE or QUOTE delegate. expires_at Timestamp The server returns UNAUTHENTICATED after this time. trader_id TraderId Account selected for this session.
ChallengeRequest
Field Type Label Description pubkey string Base58 owner or active TRADE- or QUOTE-delegate public key.
ChallengeResponse
Field Type Label Description nonce bytes Sign FLINT-MARGIN-AUTH-V1: followed by this single-use nonce. expires_at Timestamp Server rejects Authenticate after this time.
RevokeRequest
Field Type Label Description session_token string
RevokeResponse
Top
flint/margin/maker/v1/auth/service.proto
AuthService
Issues sessions through a signed challenge; TxService requires the token.
Top
flint/margin/maker/v1/common.proto
Blockhash
Field Type Label Description hash bytes
Decimal
Decimal string parsed with rust_decimal-compatible semantics.
Field Type Label Description value string
LatLng
Absent when the location is unavailable.
PerpId
Field Type Label Description id uint32
SpotId
On-chain margin spot-asset id.
Field Type Label Description id uint32
Timestamp
Unix microseconds since epoch; zero is unspecified.
Field Type Label Description micros uint64
TraderId
Field Type Label Description id uint64
HealthState
Name Number Description HEALTH_STATE_UNSPECIFIED 0 HEALTH_STATE_HEALTHY 1 HEALTH_STATE_DEGRADED 2 HEALTH_STATE_HALTED 3
Side
Name Number Description SIDE_UNSPECIFIED 0 SIDE_BUY 1 SIDE_SELL 2
Top
flint/margin/maker/v1/escalation/messages.proto
PageTheTeamRequest
Field Type Label Description message string Required non-empty message, delivered verbatim to on-call.
PageTheTeamResponse
Field Type Label Description page_id string Server-assigned page ID. received_at Timestamp When the server accepted the page.
Top
flint/margin/maker/v1/escalation/service.proto
EscalationService
Organization-authenticated escalation to the on-call team.
Top
flint/margin/maker/v1/maker/events.proto
DecodedEvent
Decoded Flint margin-program event. Type-specific data is JSON.
FillEvent
Fill where the authenticated trader provided liquidity. Side is the maker's
direction. Price and size are scaled from the perp's tick and lot grids;
maker_rebate is denominated in the perp's PnL currency.
MakerActivity
One decoded account or quoting action associated with a trader.
MakerMarketSnapshot
Perp market snapshot with the authenticated trader's best quotes.
MakerMarketsSnapshotEvent
MakerQuote
The authenticated trader's resting quote on one side of a perp.
PerpL2Level
One price level on a perp market book.
QuoteUpdate
Submitted quoting intent in a successfully executed transaction.
Field Type Label Description perp_id PerpId block_time Timestamp slot uint64 signature string instruction_index uint32 entry_index_hint uint32 Lookup hint for UpdateQuoting; exact entry index for compact batches. trader_id TraderId quoter string strategy QuotingStrategy sequence uint64 payload_json string update_kind QuoteUpdateKind update_index uint32 Zero for UpdateQuoting, otherwise the one-based item within a compact batch. applied bool optional Absent when a partial-success batch does not report individual outcomes. enabled_after bool optional Absent when the update preserves the current enabled flag.
QuoterSeriesBucket
QuoterSession
One currently-open session for a selected trader.
QuotingAuthority
Aggregate of one authority's currently-open sessions for a trader.
QuotingState
Latest observed state for one admitted on-chain quoting entry.
DecodedEventKind
Name Number Description DECODED_EVENT_KIND_UNSPECIFIED 0 DECODED_EVENT_KIND_COLLATERAL 1 DECODED_EVENT_KIND_PERP_TRADE 2 DECODED_EVENT_KIND_PERP_FILL 3 DECODED_EVENT_KIND_QUOTING_UPDATE 4 DECODED_EVENT_KIND_PERP_LIQUIDATED 5 DECODED_EVENT_KIND_FUNDING_UPDATED 6 DECODED_EVENT_KIND_FUNDING_SETTLED 7 DECODED_EVENT_KIND_PERP_CONFIG_UPDATED 8 DECODED_EVENT_KIND_FUNDING_ADVANCED 9 DECODED_EVENT_KIND_PERP_UPDATE_PROPOSED 10 DECODED_EVENT_KIND_PERP_UPDATE_CANCELLED 11
MakerActivityType
Name Number Description MAKER_ACTIVITY_TYPE_UNSPECIFIED 0 MAKER_ACTIVITY_TYPE_COLLATERAL 1 MAKER_ACTIVITY_TYPE_PERP_TRADE 2 MAKER_ACTIVITY_TYPE_QUOTING_UPDATE 3
QuoteUpdateKind
Name Number Description QUOTE_UPDATE_KIND_UNSPECIFIED 0 QUOTE_UPDATE_KIND_KEEP 1 QUOTE_UPDATE_KIND_RESET 2 QUOTE_UPDATE_KIND_ORDER_LIST 3 QUOTE_UPDATE_KIND_SPLINE_FAIR 4 QUOTE_UPDATE_KIND_SPLINE_BANDS 5 QUOTE_UPDATE_KIND_DENSITY_FAIR 6 QUOTE_UPDATE_KIND_DENSITY_BANDS 7 QUOTE_UPDATE_KIND_RELATIVE_DENSITY_BANDS 8
QuotingStrategy
Name Number Description QUOTING_STRATEGY_UNSPECIFIED 0 QUOTING_STRATEGY_ORDER_LIST 1 QUOTING_STRATEGY_SPLINE 2 QUOTING_STRATEGY_DENSITY 3 QUOTING_STRATEGY_RELATIVE_DENSITY 4
TransactionStatus
Name Number Description TRANSACTION_STATUS_UNSPECIFIED 0 TRANSACTION_STATUS_CONFIRMED 1 TRANSACTION_STATUS_FAILED 2
Top
flint/margin/maker/v1/maker/messages.proto
GetDecodedTransactionRequest
Address a transaction by its base58 signature.
Field Type Label Description signature string
GetDecodedTransactionResponse
GetFillsRequest
GetFillsResponse
GetMakerActivityRequest
Historical actions performed by the session's selected trader.
GetMakerActivityResponse
Field Type Label Description activities MakerActivity repeated Ordered newest first.
GetMakerMarkoutSummaryRequest
Whole-window markout summary, without GetFills' page limit.
Field Type Label Description perp_ids PerpId repeated start Timestamp Inclusive lower bound; unset selects the server retention window. end Timestamp Exclusive upper bound; unset selects now. horizon MarkoutHorizon
GetMakerMarkoutSummaryResponse
GetMakerStatsRequest
GetMakerStatsResponse
GetMakerVolumeBreakdownRequest
Per-trader maker volume, split by rolling window.
Field Type Label Description perp_ids PerpId repeated Empty selects every perp where the session's trader has maker fills.
GetMakerVolumeBreakdownResponse
Field Type Label Description perps PerpVolume repeated Ordered by 24-hour USD volume descending.
GetMakerVolumeSeriesRequest
Field Type Label Description perp_id PerpId Unset aggregates every perp where the session's trader has maker fills. window StatsWindow
GetMakerVolumeSeriesResponse
Field Type Label Description buckets VolumeBucket repeated Ordered oldest first. bucket_seconds uint32
GetQuoteRequest
GetQuoteResponse
GetQuotingStateRequest
Field Type Label Description perp_ids PerpId repeated
GetQuotingStateResponse
GetSdkCredentialsRequest
GetSdkCredentialsResponse
Field Type Label Description token string Plaintext read-only registry token. Repeated calls return the same token. token_name string index_url string registry_name string created_at Timestamp
ListQuoterSessionsRequest
Field Type Label Description quoter string Empty includes every session observed for the selected trader.
ListQuoterSessionsResponse
Field Type Label Description sessions QuoterSession repeated Ordered most-recently-seen first.
ListQuotingAuthoritiesRequest
Field Type Label Description quoter string Empty includes every authority observed for the selected trader.
ListQuotingAuthoritiesResponse
ListRecentQuotesRequest
ListRecentQuotesResponse
MarkoutBucket
MarkoutHistogramBin
MarkoutPerpRow
PerpVolume
SubscribeFillsRequest
Field Type Label Description perp_ids PerpId repeated
SubscribeMakerMarketSnapshotsRequest
Field Type Label Description perp_ids PerpId repeated Empty selects every perp admitted for the session's trader.
SubscribeQuotesRequest
Field Type Label Description perp_ids PerpId repeated quoters string repeated
UpdateRate
VolumeBucket
VolumeWindow
Field Type Label Description volume_usd Decimal Notional in USD, counted once for each matched long/short pair. fill_count uint64
MakerFillOrder
Name Number Description MAKER_FILL_ORDER_UNSPECIFIED 0 MAKER_FILL_ORDER_TIME_DESC 1 MAKER_FILL_ORDER_ABS_MARKOUT_DESC 2 Largest absolute USD markout first; fills without one sort last.
MarkoutHorizon
Name Number Description MARKOUT_HORIZON_UNSPECIFIED 0 MARKOUT_HORIZON_SEC_0 1 MARKOUT_HORIZON_SEC_1 2 MARKOUT_HORIZON_SEC_5 3 MARKOUT_HORIZON_SEC_15 4 MARKOUT_HORIZON_SEC_30 5
StatsWindow
Name Number Description STATS_WINDOW_UNSPECIFIED 0 STATS_WINDOW_1H 1 STATS_WINDOW_24H 2 STATS_WINDOW_30D 3
Top
flint/margin/maker/v1/maker/service.proto
MakerService
Session-authenticated maker queries and streams.
Top
flint/margin/maker/v1/node/messages.proto
GetNodeInfoRequest
GetNodeInfoResponse
Field Type Label Description version string Server build identity. git_commit string proto_hash string Schema revision used to build this node. proto_rev string cluster string Solana cluster this node is pointed at (e.g. "mainnet-beta"). region string Deploy region owning this node. program_id string Base58 program id of the on-chain venue this node serves. started_at Timestamp Process start time. leader_proximity LeaderProximity server_instance string Per-process server instance ID. region_lat_lng LatLng optional Approximate region location; absent when unavailable. health HealthState Health of this node only. health_reason string Why health is not HEALTH_STATE_HEALTHY. Empty when it is.
LeaderProximity
Observed round-trip distance to block leaders.
Field Type Label Description measured uint32 Zero means no sample; distance fields are then meaningless. mean_distance_micros uint32 median_distance_micros uint32 p90_distance_micros uint32
ListNodesRequest
Field Type Label Description cluster string Empty includes every cluster.
ListNodesResponse
Field Type Label Description nodes NodeEndpoint repeated Published endpoints only; entries do not imply current health.
NodeEndpoint
Field Type Label Description endpoint string gRPC endpoint, as host:port or URL. region string region_lat_lng LatLng optional Approximate region location; absent when unavailable. cluster string current bool True for the endpoint serving this request.
Top
flint/margin/maker/v1/node/service.proto
NodeService
Public node identity and endpoint discovery.
Top
flint/margin/maker/v1/session/messages.proto
Ping
Server liveness probe; clients echo seq in an immediate Pong.
Field Type Label Description local_time Timestamp Server wall-clock at send time. seq uint64 Per-stream correlation nonce.
Pong
Client reply to a Ping, sent immediately on receipt.
Field Type Label Description local_time Timestamp Client wall-clock at reply time; used to estimate clock drift. seq uint64 Echo of the originating Ping.seq.
SessionRequest
Field Type Label Description pong Pong
SessionResponse
Field Type Label Description ping Ping
Top
flint/margin/maker/v1/session/service.proto
SessionService
Server sends a Ping every 30s; clients reply immediately with a Pong.
Requires a keypair session via authorization: Bearer <token> metadata.
Top
flint/margin/maker/v1/spread_protect/events.proto
ResetState
Replace the client's local SpreadProtect state.
Field Type Label Description default_spread_mult Decimal Baseline multiplier to apply when no widen window is active.
SpreadProtectEvent
Spread-protection stream event.
WidenWindow
Idempotent advisory for an inclusive slot range; expires after end_slot.
Field Type Label Description start_slot uint64 Inclusive first slot of the window. end_slot uint64 Inclusive last slot of the window. spread_mult Decimal Exact decimal multiplier, at least 1.0. ts Timestamp Server send time, for client-side latency/attribution. Not policy.
Top
flint/margin/maker/v1/spread_protect/messages.proto
SubscribeSpreadProtectRequest
Subscribe to the SpreadProtect widen-window feed. No filters: the policy is
server-side and the same windows apply to every maker.
Top
flint/margin/maker/v1/spread_protect/service.proto
SpreadProtectService
Keypair-session-authenticated advisory spread-protection feed.
Top
flint/margin/maker/v1/tx/events.proto
BlockhashEvent
Field Type Label Description blockhash Blockhash recommended_cu_price uint64 Priority-fee recommendation in microlamports per CU; zero is unavailable. ts Timestamp last_valid_block_height uint64 Solana lastValidBlockHeight; zero is unavailable.
LeaderEvent
SlotEvent
TxAckEvent
Accepted for submission; not confirmation.
TxFailedEvent
Reverted after landing or timed out before landing.
TxLandedEvent
Observed at Processed commitment with no error.
TxStatusEvent
Top
flint/margin/maker/v1/tx/messages.proto
SubmitTxRequest
Field Type Label Description transaction bytes Fully signed legacy or v0 transaction. The authenticated key must be a required static signer. The selected trader scopes status attribution; the server does not infer transaction account ownership. client_sent_at Timestamp Client send time for latency telemetry only.
SubmitTxResponse
Field Type Label Description signature string Base58 signature for correlating TxStatusEvents. ts Timestamp Server time when the submission was accepted. server_replied_at Timestamp Server reply time. Subtract ts for server handling time without clock skew.
SubscribeBlockhashRequest
SubscribeLeadersRequest
SubscribeSlotsRequest
SubscribeTxStatusRequest
Streams status transitions attributed to this session's selected trader.
Top
flint/margin/maker/v1/tx/service.proto
TxService
Requires authorization: Bearer <token> metadata from AuthService.
Scalar Value Types
.proto Type Notes C++ Java Python Go C# PHP Ruby doubledouble double float float64 double float Float floatfloat float float float32 float float Float int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required) int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum uint32Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required) uint64Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required) sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required) sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required) fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum sfixed32Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required) sfixed64Always eight bytes. int64 long int/long int64 long integer/string Bignum boolbool boolean boolean bool bool boolean TrueClass/FalseClass stringA string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8) bytesMay contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)