settle

Settled tokens in the user's open order account.

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/settle

Parameters:

Parameter	Type	Description
ownerAddress	string	User's account address to settle
market	string	Smart contract address/symbol of the market.
baseTokenWallet	string	OPTIONAL. User's wallet address for the market's base token. Specify for a faster response.
quoteTokenWallet	string	OPTIONAL. User's wallet address for the market's quote token. Specify for a faster response.
openOrdersAddress	string	OPTIONAL. Specify for a faster response.
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/settle' \
  -H 'Content-Type: application/json' \
  -d '{
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "market": "SOLUSDC",
  "baseTokenWallet": "BFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDss",
  "quoteTokenWallet": "CFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDbb",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
}'

WebSocket

wscat --header "Authorization: $AUTH_HEADER"
-c wss://ny.solana.dex.blxrbdn.com/ws --execute '{"jsonrpc": "2.0", "id": 1, "method": "PostSettle", "params": {
  "ownerAddress": "AFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDfQ",
  "market": "SOLUSDC",
  "baseTokenWallet": "BFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDss",
  "quoteTokenWallet": "CFT8VayE7qr8MoQsW3wHsDS83HhEvhGWdbNSHRKeUDbb",
  "openOrdersAddress": "5yyh4mzzycmjfR6arY736d1mB6vNSLiUaFWfepKLf8kZ"
}}'

Go

//Make sure to set environment variable AUTH_HEADER.
settleTransaction, err := g.SettleFunds(
    context.Background(),
    "BraJjCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSjcgC", //owner solana wallet address
    "SOL/USDC", // market 
    "4raJjCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSjcgv", // base SPL token wallet address 
    "CbafjCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSjFun", // quote SPL token wallet address 
    "neePfCwLLqw8TciQXYruDEF4YhDkGwoEnwnAdwJSJOKE", // open orders account address for this market
    )
// Settle relies on the PRIVATE_KEY env variable holding your wallet's private key, to sign the transaction

Python

#Make sure to set environment variable AUTH_HEADER.
await api.post_settle(
    owner_address=PUBLIC_KEY,
    market="SOLUSDC",
    base_token_wallet=PUBLIC_KEY,
    quote_token_wallet=USDC_WALLET,
    open_orders_address="",  # optional
)

TypeScript

await provider.postSettle({
    market: marketAddress,
    openOrdersAddress: openOrdersAddress,
    baseTokenWallet: baseTokenWallet,
    quoteTokenWallet: quoteTokenWallet,
    ownerAddress: ownerAddress,
    project: "P_OPENBOOK",
})

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"
}