RFQ REST API
The REST API carries every client-initiated action: authentication, RFQ submission and acceptance, maker quoting, and balance and funding operations. Reads are available over REST too; for live updates, pair it with the WebSocket API.
Endpoint-level documentation lives in the interactive REST reference, rendered from the OpenAPI 3.1 spec at /api/rfq-openapi.yaml.
Surface
All paths are under https://rfq-api.silhouette.exchange/v1. Private endpoints require HMAC-signed requests.
| Area | Paths | What it covers |
|---|---|---|
| Auth | /v1/auth/* | SIWE login challenge, API key minting, listing, and revocation |
| Instruments | /v1/rfq/instruments*, /v1/rfq/tokens* | Public instrument and token metadata, including top-of-book |
| RFQs (taker) | /v1/rfq/requests* | Submit, read, cancel, list quotes on, and accept an RFQ |
| Maker | /v1/rfq/maker/* | Open RFQs for approved instruments, quote submission and cancellation |
| Balances | /v1/rfq/balances, /v1/rfq/ledger | Balance state, one line per token and custody rail, and the append-only ledger |
| Funding | /v1/rfq/funding, /v1/rfq/deposits*, /v1/rfq/withdrawals* | Funding details, deposits, and withdrawals |
Conventions
- Identifiers are opaque, type-prefixed strings (
rfq_,qt_,dep_,wd_). Store and return them verbatim; never parse them. - Amounts are exact decimal strings in human-readable units, never floating point. How many decimal places a request may carry depends on where the amount is paid from, so a withdrawal finer than its custody rail accepts is refused as
AMOUNT_OVER_PRECISE, withdetails.maxDecimalsnaming the limit. - A market can set a smallest order value it takes, published on the instrument as
minQuoteNotional. On aBUYthe RFQ'squoteLimitmust cover it plus the taker fee charged on it; a smaller request is refused asBELOW_MIN_NOTIONAL, withdetails.minQuoteNotionalnaming the figure. A market that sets no minimum omits the field. A spotbaseQtymust also be a multiple of the instrument's publishedbaseQtyIncrement; one off the step is refused asBASE_QTY_OFF_INCREMENT, withdetails.incrementnaming the step. - Instants are Unix milliseconds with an
Atsuffix (auctionEndsAt); durations are milliseconds withMs(windowMs,acceptableForMs). The exception is theDeadlinesuffix (settlementDeadline,deliveryDeadline), which carries Unix seconds: these are on-chain-native values relayed verbatim, so they stay in the unit the chain reads. - Lists are cursor-paginated:
limitandcursorin,{ items, hasMore, nextCursor }out.nextCursoris always present, and null whenhasMoreis false. Your own history and a maker's own lists also take filters and a sort order, described under Filtering and ordering lists. - Mutating submissions carry a client-generated
idempotencyKey(UUID). A replay under the same key returns the originally created resource instead of executing again. A replay whose terms contradict the original, such as a withdrawal naming a differentrailfrom the one that paid, is refused instead. - Errors carry a stable machine-readable
codeand a human-readablemessage. Branch oncode; the set grows additively, so treat an unknown code as a generic failure of its class.
Filtering and ordering lists
See the API reference for each list's filters and sort options. Pass nextCursor unchanged to the same list with the same filters; it preserves the sort order. Start without a cursor when changing the list, filters or order.
Continue until hasMore is false, even if a filtered ledger page is empty.
Cancelling an RFQ
POST /v1/rfq/requests/{id}/cancel succeeds only after Silhouette cancels the RFQ and releases its locked funds. A 503 means Silhouette did not submit the cancellation, so you may retry it.
A 500 INTERNAL_SERVER_ERROR leaves the outcome unknown. Read GET /v1/rfq/requests/{id} or follow rfqStatus before taking another action. A PENDING reading does not rule out a cancellation still in progress. Do not retry blindly; cancellation has no idempotency key, and a repeat after cancellation returns 409.
Generating clients
The OpenAPI Generator tool can generate strongly-typed client SDKs from the REST spec in many languages, including TypeScript, Python, Java, Go, and Rust.
# Install the OpenAPI Generator CLI
npm install @openapitools/openapi-generator-cli -g
# Generate a TypeScript Axios client
openapi-generator-cli generate \
-i https://docs.silhouette.exchange/api/rfq-openapi.yaml \
-g typescript-axios \
-o ./generated-client
# Generate a Python client
openapi-generator-cli generate \
-i https://docs.silhouette.exchange/api/rfq-openapi.yaml \
-g python \
-o ./generated-client
See the OpenAPI Generator generators list for all supported languages.