Files

2.4 KiB

NLP Interest Payments

Rate limits

  • 480 requests/min or 80 requests/10secs per IP address. (weight = 5)

{% hint style="info" %} See more details in API Rate limits {% endhint %}

Request

{% tabs %} {% tab title="NLP Interest Payments" %} Query historical NLP interest payments.

POST [ARCHIVE_ENDPOINT]

Body

{
  "nlp_interest_payments": {
    "max_idx": "1315836",
    "max_time": "1683315718",
    "limit": 100
  }
}

{% endtab %} {% endtabs %}

Request Parameters

ParameterTypeRequiredDescription
max_idxnumber / stringNoWhen provided, only return payments with idx <= max_idx.
max_timenumber / stringNoWhen provided, only return payments with timestamp <= max_time (unix epoch in seconds).
limitnumberNoMax number of payments to return. Defaults to 100. Max of 500.

Response

{
  "interest_payments": [
    {
      "product_id": 0,
      "idx": "5968022",
      "timestamp": "1701698400",
      "amount": "12273223338657163",
      "balance_amount": "45382847293847329847"
    }
  ],
  "next_idx": "5968021"
}

Response Fields

Interest Payments

Field nameDescription
product_idId of the spot product (typically quote/collateral products)
idxSubmission index of the transaction that triggered the payment
timestampUnix epoch time in seconds when the payment occurred
amountInterest payment amount (x18 format)
balance_amountBalance amount at the time of payment (x18 format)