Skip to main content

API reference

The MetaFlux API is one MTF-native protocol. The gateway serves it at https://api.<net>.mtf.exchange.

SurfaceWhereNotes
MTF-nativePOST /exchange, POST /info, GET /ws, POST /faucetCompact snake_case shape. It exposes all features, including the advanced MTF features (RFQ, FBA, PM enrollment, cross-chain).

The gateway serves the MTF-native surface (/info, /exchange, /ws). A node that you run yourself serves the same native surface directly at http://localhost:8080.

Common tasks​

TaskPage
Make a first callQuickstart
Place an ordersubmit_order, then placing orders
Sign a requestSigning and typed data
Read an accountaccount_state
Stream the book or your fillsWS subscriptions
Find the fields of one actionThe action catalog
Find why a request was refusedErrors
Use a client libraryTypeScript and Rust

REST​

  • POST /exchange: the envelope, signing and the action catalog. The fields of each action are on the page of its lane. The catalog links to each page.
  • POST /info: the schema of each read type

WebSocket​

Shared topics​

  • Errors: the response envelope, every error code and the action for each code
  • Rate limits: the weight budget for each IP and the request budget for each account

See also​