Skip to main content
POST
/
v1
/
sell
/
quote
Create sell quote
curl --request POST \
  --url https://api.developer.coinbase.com/onramp/v1/sell/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientIp": "<string>",
  "cashoutCurrency": "<string>",
  "country": "<string>",
  "partnerUserId": "<string>",
  "paymentMethod": "UNSPECIFIED",
  "redirectUrl": "<string>",
  "sellAmount": "<string>",
  "sellCurrency": "<string>",
  "sellNetwork": "<string>",
  "sourceAddress": "<string>",
  "subdivision": "<string>"
}'
{
  "cashout_subtotal": {
    "currency": "<string>",
    "value": "<string>"
  },
  "cashout_total": {
    "currency": "<string>",
    "value": "<string>"
  },
  "coinbase_fee": {
    "currency": "<string>",
    "value": "<string>"
  },
  "offramp_url": "<string>",
  "quote_id": "<string>",
  "sell_amount": {
    "currency": "<string>",
    "value": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your JSON Web Token (JWT) here. Refer to the Generate JWT section of our Authentication docs for information on how to generate your Bearer Token.

Body

application/json

Create Sell Quote API request parameters

​
clientIp
string
required

The client IP address of the end user. This parameter is required for security validation to ensure the quote can only be used by the requesting user. Do not trust HTTP headers like X-Forwarded-For — these can be easily spoofed.

​
cashoutCurrency
string
required

Fiat currency to be cashed out to e.g. USD

​
country
string
required

The ISO 3166-1 two letter country code e.g. US

​
paymentMethod
enum<string>
required

Payment method type to be deposited to

Available options:
UNSPECIFIED,
CARD,
ACH_BANK_ACCOUNT,
APPLE_PAY,
FIAT_WALLET,
CRYPTO_ACCOUNT,
GUEST_CHECKOUT_CARD,
PAYPAL,
RTP,
GUEST_CHECKOUT_APPLE_PAY
​
sellAmount
string
required

Amount of sell_currency to be converted to fiat e.g. 0.05

​
sellCurrency
string
required

The ticker (e.g. BTC, USDC) or the UUID (e.g. d85dce9b-5b73-5c3c-8978-522ce1d1c1b4) of crypto asset to be sold

​
partnerUserId
string

Partner's user identifier. Optional field for quote, required for generating a ready-to-use one-click-sell URL

​
redirectUrl
string

URL to redirect after transaction completion. Optional field for quote, required for generating a ready-to-use one-click-sell URL

​
sellNetwork
string

Network name crypto will be sent on e.g. ethereum, base

​
sourceAddress
string

Optional source address for the asset to sell. Optional field for quote, required for generating a ready-to-use one-click-sell URL

​
subdivision
string

The ISO 3166-2 two letter state code e.g. NY, only required for US

Response

OK

Create Sell Quote API response

​
cashout_subtotal
object

A monetary amount represented by a decimal value and currency symbol

​
cashout_total
object

A monetary amount represented by a decimal value and currency symbol

​
coinbase_fee
object

A monetary amount represented by a decimal value and currency symbol

​
offramp_url
string

Ready-to-use offramp URL. Only returned when sourceAddress, redirectUrl, and partnerUserId are ALL provided in the request

​
quote_id
string

UUID that should be passed into the Offramp Widget URL as the quoteId query parameter

​
sell_amount
object

A monetary amount represented by a decimal value and currency symbol

⌘I