Prime FIX Messages

The baseline specification for this API is FIX 4.2. Below, we’ve noted the places in which the FIX API for Coinbase Prime extends (or clarifies) the FIX spec. For example, there are custom tags with a four-digit number range, as allowed by the standard, which are unique to Prime.

A standard header must be present at the start of every message in both directions. You should configure your sessions so that

• SenderCompID = the Service Account ID associated with the API key as your SenderCompID
• TargetCompID = the string COIN

This is typically accomplished via your FIX client’s configuration file.

​

Logon (A)

Sent by the client to initiate a session and by the server as an acknowledgement. Only one session can exist per connection — sending a Logon message within an established session results in an error.

The Logon message sent by the client must be signed for security. The prehash string has the following fields, each joined by the empty string:

{timestamp}A{seqNum}{apiKey}{targetComp}{passphrase}.

There is no trailing separator. The RawData field should be a base64 encoding of the HMAC signature.

To establish multiple FIX connections, you must generate a new API key for each one. All messages must have a SendingTime value within 5 seconds of server time in UTC or they are rejected.

Contact primeops@coinbase.com to create an API key for accessing multiple portfolios in a single fix connection.

​

Python Example

def toAdmin(self, message, sessionID):
    if message.getHeader().getField(35) == "A":
        rawData = self.sign(message.getHeader().getField(52), message.getHeader().getField(35),
                            message.getHeader().getField(34), self.API_KEY, message.getHeader().getField(56),
                            self.PASSPHRASE)
        message.setField(fix.StringField(554, self.PASSPHRASE))
        message.setField(fix.StringField(96, rawData))
        message.setField(fix.StringField(9407, self.API_KEY))
        msg = message.toString().replace(__SOH__, "|")
        logfix.info("(Admin) S >> %s" % msg)
        return
    else:
        return

def sign(self, t, msg_type, seq_num, access_key, target_comp_id, passphrase):
    message = ''.join([t, msg_type, seq_num, access_key, target_comp_id, passphrase]).encode("utf-8")
    hmac_key = self.API_SECRET
    signature = hmac.new(hmac_key.encode('utf-8'), message, hashlib.sha256)
    sign_b64 = base64.b64encode(signature.digest()).decode()
    return sign_b64

​

JavaScript Example

// create a new Logon message
var logon = new Msgs.Logon();
logon.SendingTime = new Date();
logon.passphrase = "...";
var presign = [
  logon.SendingTime,
  logon.MsgType,
  session.outgoing_seq_num,
  apiKey,
  session.target_comp_id,
  passphrase,
].join("");
// add the presign string to the RawData field of the Logon message
logon.RawData = sign(presign, secret);
// send the logon message to the server
session.send(logon);

function sign(what, secret) {
  var key = Buffer.from(secret, "base64");
  var hmac = crypto.createHmac("sha256", key);
  return hmac.update(what).digest("base64");
}

​

New Order Single (D)

Sent by the client to enter an order. Not every tag is required for every order — it depends on the target strategy used. See the table below for more information.

​

TargetStrategy Values

​

OrdType Values

​

TimeInForce Values

​

RFQ

​

Quote Request (R)

A Quote Request (R) is the start of the RFQ process. Coinbase Prime sends a Quote Request to Liquidity Providers (LPs) on behalf of a customer looking to participate in an RFQ trade. LPs respond to a Quote Request (R) with a Quote (S).

​

Quote (S)

Quote (S) messages are submitted by Liquidity Providers (LP) in response to a Quote Request (R) in order to participate in the competitive RFQ auction.

​

Accept quote - New Order Single (D)

Sent by the client in order to accept a Quote (S). Must be accepted before expiration time indicated on Tag 62 of Quote (S). Refer to New Order Single (D) for standard fields of submitting an order.

​

Quote Acknowledgment (b)

Sent by the server in case the Quote Requests (R) fails.

​

QuoteRejectReason

Possible values for QuoteRejectReason (see Quote Acknowledgment (b)).

​

Order Cancel Request (F)

Sent by the client to cancel an order.

​

Order Status Request (H)

Sent by the client to obtain information about pending and completed orders.

​

Python Example

def get_order_status(self, order_id, clord_id):
   '''Send Order Status Request Message (H)'''
   order_status_message = fix.Message()
   header = order_status_message.getHeader()
   header.setField(fix.MsgType(fix.MsgType_OrderStatusRequest))  # 35 = H
   order_status_message.setField(fix.OrderID(order_id))
   order_status_message.setField(fix.ClOrdID(clord_id))
   order_status_message.setField(fix.Side(fix.Side_BUY))
   order_status_message.setField(fix.Symbol("DOGE-USD"))
   fix.Session.sendToTarget(order_status_message, self.sessionID)

​

FIX Message Request: (35=H)

8=FIX.4.2|9=181|35=H|34=12|49=SENDERCOMPID|52=20220526-16:12:08.000|56=COIN|11=CLOrdID|37=OrderID|54=1|55=DOGE-USD|10=011|

​

FIX Message Response:

8=FIX.4.2|9=307|35=8|34=13|49=COIN|52=20220526-16:12:08.134|56=TARGETCOMPID|1=ACCOUNT|6=0|11=CLOrdID|14=0|17=ExecID|20=1|32=0.0|37=OrderID|38=100|39=4|54=1|55=DOGE-USD|150=4|151=100|10=255|

​

Execution Report (8)

Sent by the server when an order is accepted, rejected, filled, or canceled. Also sent when the user sends an OrderStatusRequest.

​

OrdRejReason Values

​

MiscFeeType Values

​

ExecType Values

​

Order Cancel Reject (9)

Sent by the server when an Order Cancel Request cannot be satisfied, e.g., because the order is already canceled or completely filled.

​

OrdStatus Values

​

CxlRejResponseTo Values

​

Reject (3)

Sent by either side upon receipt of a message which cannot be processed, e.g., due to missing fields or an unsupported message type.