Skip to main content
GET
/
loans
/
loan-preview-xm
Get loan preview XM
curl --request GET \
  --url https://api.exchange.coinbase.com/loans/loan-preview-xm \
  --header 'cb-access-key: <api-key>' \
  --header 'cb-access-passphrase: <api-key>' \
  --header 'cb-access-sign: <api-key>' \
  --header 'cb-access-timestamp: <api-key>'
{
  "before": {
    "open_loan_value": "<string>",
    "available_to_borrow": "<string>",
    "withdrawal_restricted": true,
    "credit_limit_value": "<string>",
    "available_credit_value": "<string>",
    "pending_loan_value": "<string>",
    "margin_requirement": "<string>",
    "account_equity": "<string>",
    "margin_excess_shortfall": "<string>",
    "consumed_credit": "<string>"
  },
  "after": {
    "open_loan_value": "<string>",
    "available_to_borrow": "<string>",
    "withdrawal_restricted": true,
    "credit_limit_value": "<string>",
    "available_credit_value": "<string>",
    "pending_loan_value": "<string>",
    "margin_requirement": "<string>",
    "account_equity": "<string>",
    "margin_excess_shortfall": "<string>",
    "consumed_credit": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloud.coinbase.com/llms.txt

Use this file to discover all available pages before exploring further.

Preview the results of a loan for a cross margin user. This endpoint shows the before and after state of your lending overview when taking out a new loan.
Loan Preview for Cross Margin (XM) UsersUse this endpoint to preview how a new loan would affect your cross margin account’s margin requirements, account equity, and other lending metrics before actually opening the loan.
CautionThe lending rate limit is 10 RPS per profile.

Authorizations

​
cb-access-key
string
header
required
​
cb-access-passphrase
string
header
required
​
cb-access-sign
string
header
required
​
cb-access-timestamp
string
header
required

Query Parameters

​
currency
string
required
​
native_amount
string
required

Response

A successful response.

​
before
object
​
after
object