replace

Create raw bytes of an unsigned transaction to place an order by specified parameters.

This endpoint does not submit the transaction to the network.

The endpoint allows you to specify priority fees and tips to later control the transaction inclusion and propagation. Refer to the Transaction Submission & Front-Running Protection & Transaction Bundle page for additional information about these parameters.

Request

Method:

POST ./api/v2/openbook/replace

Parameters:

Parameter	Type	Description
orderID	string	Unique order ID to be replaced. This order ID is assigned by the orderbook after processing, and can be difficult to associate with a transaction without the clientOrderId.
clientOrderId	string	OPTIONAL. Client order id which can be customized by the user.
ownerAddress	string	User's account address to place order
payerAddress	string	Account address to pay for the order. Typically, this is the same as ownerAddress if providing SOL, else the SPL token wallet for the relevant token.
market	string	Smart contract address/symbol of the market.
side	string	Order type, “ASK” or “BID”
amount	number	Order size
price	number	Order price. Not applicable if the type is "market"
type	string	Supported types: "LIMIT", "IOC", "POSTONLY"
openOrdersAddress	string	Define with open order address to place the order in case of having multiple open order addresses.
computeLimit	number	OPTIONAL. Specifies total compute limit to be allocated for all instructions within the created tx
computePrice	number	OPTIONAL. Specifies compute price in Lamport (0.000001 SOL = 1,000 Lamport) to be included as a part of instruction, known as priority fee.
tip	uint64	OPTIONAL. Specifies a tip amount that will be used to pay for front-running protection or bundle submission services. What is tip?

Request example:

HTTP

curl --header "Authorization: $AUTH_HEADER" \
-X 'POST' \
  'https://ny.solana.dex.blxrbdn.com/api/v2/openbook/replace' \
  -H 'Content-Type: application/json' \
  -d '{
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "payerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "market": "SOLUSDC",
  "side": "S_ASK",
  "amount": 0,
  "price": 0,
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ",
  "clientOrderID": "12324",
  "orderID": "1569817920672682842648894460"
}'

WebSocket

wscat --header "Authorization: $AUTH_HEADER"
-c ws://ny.solana.dex.blxrbdn.com/ws --wait 1000 --execute '{"jsonrpc": "2.0", "id": 1, "method": "PostReplaceOrder", "params": {
  "orderID": "1569817920672682842648894460",
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "payerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "market": "SOLUSDC",
  "side": "S_ASK",
  "type": [
    "OT_LIMIT"
  ],
  "amount": 0.1,
  "price": 10000000,
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ",
  "clientOrderID": "1234"
}}'

Go

//Make sure to set environment variable AUTH_HEADER.
transaction, err := g.PostReplaceOrder(
    ctx,
    "1569817920672682842648894460", // orderID to replace
    "BraJjCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSjcgC", // owner solana wallet address
    "4raJjCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSjcgv", // SPL token wallet address 
    "SOL/USDC", // market 
    pb.Side_S_BID, // trade side (Bid/Ask)
    []pb.OrderType{pb.OrderType_OT_LIMIT}, // OrderType
    20, // order size
    float64(0.124), // order price 
    provider.PostOrderOpts{
        ClientOrderID: 5000, // Client controlled OrderID
    }
)

Python

#Make sure to set environment variable AUTH_HEADER.
await api.submit_replace_order(
    owner_address=PUBLIC_KEY,
    payer_address=PUBLIC_KEY,
    market="SOLUSDC",
    side=proto.Side.S_ASK,
    types=[proto.OrderType.OT_LIMIT],
    amount=0.1,
    price=150_000,
    # optional, but much faster if known
    open_orders_address="5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ",
    # optional, for identification
    client_order_id=0,
    order_id=""
)

TypeScript

await provider.postReplace({
    orderId: "12345",
    ownerAddress: ownerAddress,
    payerAddress: payerAddress,
    market: "SOLUSDC",
    side: "S_ASK",
    type: ["OT_LIMIT"],
    amount: 0.1,
    price: 200,
    project: "P_UNKNOWN",
})

Response:

Fields:

Field	Description
transaction	Raw bytes of unsigned transaction
openOrdersAddress	The open order address to place the order

Example:

JSON

{
  "transaction": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC3VviHhRXwajmbHjA81VWXrZn5eFs8QQgktl0zJIHYBY3t6VHnwK40CkHx94w499MTm6w2xUFNd4g/td6s0OsDAgAFD4ls26fgpAnCYufUzDrXMMpDjMYkf2Y2FHuxqKE+2+Ir4JOYQLjX3gNAS/hRzKTUUu1/FlowlWLc1wv3nKsGTt6EwvsYrtYZ9UZjJlPvBgKfAqhkvzgphnGBuyDfHXFcMEoHX5xmEhJgK0YZx3BKh/s3nhpE7IFyBzqsKBqiTDd6jfzI9XsPznt1ZnWa9u9nVKg1KibD5ElrzSfbftYpluJAIIlGU8/d+nt+YMlmaCc2otsPg4VkklsRB3oh4DbXlwD0JuFuuM8DEZF1+YBRQ0SVXONw52WUDzwpQ5VF+0Wppt/RXFB3Bfkzm5U8Gk39vJzBht0vYt9IqVgEXip2UlkfJvXwRhxAEL1cyMpwZt2lhKbucXk0xnet9MJfvRVqLWrj7TJ6D4hJp3KUHZcFDzpujLjdOrzbFHCIfIK1TT82BpuIV/6rgYT7aH9jRhjANdrEOdwa6ztVmKDwAAAAAAEGp9UXGSxcUSGMyUw9SvF/WNruCJuh/UTj29mKAAAAAAbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCpAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACFDy1uAqR6+CTQmradxC1wyyjL+iSft+5XudJWwSdi72WJF7hI17QuJRRi1EmSpQkUrNAwom+Kp9LFCTP8SA/pBA0CAAE0AAAAAIB3jgYAAAAApQAAAAAAAAAG3fbh12Whk9nL4UbO63msHLSF7V9bN5E6jPWFfv8AqQwEAQoACwEBDgwCAwQFBgcBAAgJDAszAAoAAAABAAAAAOQLVAIAAAABAAAAAAAAAAAQpdToAAAAAAAAAAAAAADSBAAAAAAAAP//DAMBAAABCQ==",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
}