Get Interest Accrual History

Time	Status	User Agent
Retrieving recent requests…

Returns paginated MarginX interest-accrual records across your groups or for one specified group. Each record contains the rate, calculation base and new interest for that period, not the current unpaid interest balance.

Rate limit: 10 requests per minute per API key.

API key access

Requires a signed LTP Open API request with READ permission. See Authentication.

API key type	Can call	Scope
Main User Level API key (also the Main Portfolio key)	Yes	Interest records in margin groups belonging to the main user.
Sub-user Level API key	No	Not supported.
Dedicated Sub Portfolio Level API key	No	Not supported.
Exchange-native API key	No	Use an LTP Main User Level API key.

Query parameters

All query parameters are optional.

Name	Type	Default	Description
`page`	integer	`1`	One-based page number. Zero, negative or empty values use `1`.
`pageSize`	integer	`20`	Records per page, maximum `1000`. Zero, negative or empty values use `20`; values above `1000` are rejected.
`groupId`	string	No filter	Exact margin group ID. Omit to query all your groups. If supplied, it must be a positive integer expressed as a string. Empty/whitespace values and group names are invalid.
`sortBy`	string	`createdAt`	`createdAt`, `periodOutstandingAmount`, `periodInterestAmount` or `annualInterestRate`. Empty uses `createdAt`.
`sortDirection`	string	`DESC`	`ASC` or `DESC`. Input is case-insensitive. Empty uses `DESC`.

Quantities are in each record's currency. There is no quoteCurrency parameter or valuation-currency conversion.

Pagination and filtering

Non-integer or out-of-range integer pagination values return 1002. An integer pageSize above 1000 returns 100400; it is not silently capped.
Sorting is applied before pagination. A page beyond the end returns list: [] and retains the matching totalSize. There is no pageNum field.
A valid group without interest history returns success with totalSize: 0 and list: []. An unavailable or deleted group returns an error instead.

Response fields

Field	Type	Description
`code`	integer	`200` means success; any other value indicates an error.
`message`	string	Result message.
`data.page`	integer	Page number used.
`data.pageSize`	integer	Page size used.
`data.totalSize`	integer	Total matching records, not just the current page.
`data.list`	array of objects	Interest records on this page.

Interest record: `data.list[]`

IDs, quantities and annual interest rates are strings. Timestamps are Unix milliseconds. Each record keeps its applicable historical rate rather than replacing it with the current rate.

Field	Type	Description
`groupId`	string	Margin group ID.
`groupName`	string	Group name.
`primeType`	string	Account family of the member carrying the debt: `dma` or `rapidx`.
`memberId`	string	DMA account ID or RapidX Portfolio ID of that member.
`venue`	string	Member's exchange; for RapidX, its specific Portfolio venue.
`currency`	string	Currency used for the calculation base and interest quantities.
`currencyDetails`	object or null	Currency metadata; see below.
`interestRateType`	string	`FLOATING` for the standard floating rate, or `FIXED` for a fixed rate. `FIXED` can also result from an administrative fixed-rate adjustment; it does not necessarily identify a fixed-term loan.
`termDays`	integer or null	Fixed-term duration in days when applicable and available. `null` for floating records and for administratively fixed-rate records without a fixed term.
`maturityDate`	integer or null	Fixed-term maturity time in Unix milliseconds when applicable and available. May be `null` even when `interestRateType` is `FIXED`.
`annualInterestRate`	string	Annual rate applied to this record, as a decimal. `"0.1345"` means 13.45% annually, not a daily rate.
`periodInterestAmount`	string	New interest charged for this period, in `currency`, not accumulated unpaid interest.
`periodOutstandingAmount`	string	Calculation base used for this record, in `currency`. Usually includes outstanding principal and interest, and may also include borrowing repaid within the preceding cycle but still subject to this interest calculation. It is not simply the period-end unpaid balance.
`createdAt`	integer	Record creation time in Unix milliseconds.

Do not infer a fixed borrowing duration from interestRateType=FIXED alone. Rate type and loan duration are separate concepts. Likewise, do not replace periodOutstandingAmount with the current outstanding balance when interpreting a historical interest record.

`currencyDetails`

Field	Type	Description
`id`	integer	Currency identifier.
`iconUrl`	string	Currency icon URL.
`currencyName`	string	Currency display name.
`slug`	string	Currency slug.
`referenceAssetId`	integer or null	Reference asset identifier.
`multiplier`	number or null	Conversion multiplier to the reference asset.

The response panel includes floating, administratively fixed-rate and fixed-term record examples, plus empty-list and error responses.

Error codes

Errors can return HTTP 200 with a non-success JSON code. Check code, not HTTP status alone. See Error Codes for shared errors.

Code	When it occurs	What to do
`1002`	A pagination value cannot be converted to a supported integer.	Send integer values; the message identifies the affected field.
`100400`	Invalid group ID, `pageSize` above `1000`, or invalid sorting parameters.	Use the supported values. Omit `groupId` for all groups; do not send an empty value.
`-1`	The requested group is unavailable; observed message: `resource unavailable`.	Check the group ID and whether it still exists.
`2000`	Signature verification fails.	Check the signature and authentication headers.
`2003`	The calling API key level is not allowed.	Use a Main User Level API key.
`2004`	The key lacks a required permission.	Use a key with `READ` permission.
`100429`	Rate limit exceeded.	Reduce the request rate.