Skip to main content
GET
/
loans
/
lending-overview-xm
Get lending overview XM
curl --request GET \
  --url https://api.exchange.coinbase.com/loans/lending-overview-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>'
{
  "body": {
    "overview": {
      "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>"
    },
    "loans": [
      {
        "id": "<string>",
        "currency": "<string>",
        "principal_amount": "<string>",
        "outstanding_principal_amount": "<string>",
        "interest_rate": "<string>",
        "interest_currency": "<string>",
        "status": "loan_pending",
        "effective_at": "2023-11-07T05:31:56Z",
        "closed_at": "2023-11-07T05:31:56Z",
        "term_start_date": "2023-11-07T05:31:56Z",
        "term_end_date": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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.

Get lending overview for a cross margin user with margin requirements and account equity information. Returns all amounts in USD notional values.
Lending Overview for Cross Margin (XM) UsersThis endpoint provides lending information specifically for cross margin users, including margin requirements, account equity, and margin excess/shortfall calculations.
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

​
user_id
string

Optional, user in admin auth

Response

A successful response.

​
body
object