FTX OTC Portal API

Send a message with the following payload:

{
    "op": "login",
    "args": {
        "api_key": "your-api-key",
        "sign": "signature-using-api-secret",
        "timestamp": 1647980276000
    }
}

Upon successfully logging in you will receive the following message:

{
    "type": "login",
    "message": "logged in"
}

Our signature format for RFS is the SHA256 HMAC of the request timestamp (in milliseconds) signed with your api secret. You may use the same signing function as for RFQ authentication, with method, path and request data as empty strings

Send a message with the following payload:

{
    "op": "subscribe",
    "channel": "quotes",
    "baseCurrency": "ETH",
    "quoteCurrency": "USD",
    "baseCurrencySize": 100.0
}

Optionally you can include a clientId argument that will be passed back on each payload in the stream. This must be unique

Upon successfully subscribing, you will receive a message to confirm this:

{
    "type": "subscribed",
    "channel": "quotes",
    "userId": 1,
    "baseCurrency": "ETH",
    "quoteCurrency": "USD",
    "baseCurrencySize": 100.0,
    "clientId": "uvm123"
}

You can unsubscribe to a stream by passing in the same payload you would use to subscribe, except with "op": "unsubscribe":

{
    "op": "unsubscribe",
    "channel": "quotes",
    "baseCurrency": "ETH",
    "quoteCurrency": "USD",
    "baseCurrencySize": 100.0
}

The messages in the quote stream will be of the form:

{
    "channel": "quotes",
    "userId": 1,
    "baseCurrency": "ETH",
    "quoteCurrency": "USD",
    "baseCurrencySize": 100.0,
    "type": "update",
    "clientId": "uvm123",
    "data": {
        "id": 3286,
        "askPrice": 2875.91,
        "bidPrice": 2872.9,
        "expiresAt": 1647843528197,
        "quotedAt": 1647843468197,
        "clientId": "uvm123",
        "baseCurrency": "ETH",
        "quoteCurrency": "USD",
        "baseCurrencySize": 100.0,
    }
}

If you disconnect and then resubscribe, and the latest quote you had been sent before you disconnected is still alive, then you will receive that quote upon subscribing except the "type" of this payload will be "latest" rather than "update"

Send a message with the following payload:

{
    "op": "trade",
    "quoteId": 3286,
    "side": "buy",
    "price": 2875.91,
    "baseCurrencySize": 10.0,
    "clientOrderId": "abc123"
}

• To sell instead of buy, set side to "sell"

• The price you submit will be the worst possible price you are willing to receive

  • If FTX/FTXUS can execute at a price better for the client, we will
  • If FTX/FTXUS is not willing to execute at a price better than or equal to this price, you will not receive a fill

• Sizes:

  • You may also set a "quoteCurrencySize"
  • You must set exactly "baseCurrencySize" or "quoteCurrencySize"; not both
  • You may execute with a size less than or equal to the size of the stream
  • Orders you send are fill-or-kill; if we cannot execute the whole size, you will receive no fill

• Client IDs are optional; they can be ascii strings up to 32 characters. If you do not pass this in, we will create it for you

When a trade is executed, you will immediately receive a fill of the form:

{
    "type": "fill",
    "message": "sold 0.00023428 BTC @ 42,683.16 (received 9.9998107 USD)",
    "data": {
        "order": {
            "id": 1255,
            "streamingQuoteId": 4112,
            "side": "sell",
            "price": 42683.16,
            "state": "filled",
            "clientOrderId": "abc123"
            "placedAt": "2022-03-22T21:23:05.138897"
        },
        "quote": {
            "baseCurrency": "BTC",
            "quoteCurrency": "USD",
            "maxBaseCurrencySize": 10.0,
            "id": 4112,
            "askPrice": 42717.25,
            "bidPrice": 42683.16,
            "expiresAt": 1647984185885,
            "quotedAt": 1647984185004,
            "fillId": 41513991,
            "unsettledCost": 0.0,
            "unsettledProceeds": 0.0,
            "clientId": "xvu123"
        },
        "fill": {
            "id": 41513991,
            "orderId": 291669965,
            "market": "BTC-USD",
            "baseCurrency": "BTC",
            "quoteCurrency": "USD",
            "side": "sell",
            "price": 42683.16,
            "size": 0.00023428,
            "liquidity": "taker",
            "fee": 0.0,
            "feeCurrency": "BTC",
            "time": "2022-03-22T21:23:05.173244+00:00"
        }
    },
    "channel": "fills"
}

Shortly after receiving the fill, you may also receive cancelled (and subsequently updated) quotes for other streams

The payload for a cancelled quote is identical to a quote update, except the "type" is "cancel" and the "expiresAt" timestamp will be in the past