Get Monthly Account Interest

Use GET on /account/:id/interest with an interestMonth query value in YYYY-MM format to retrieve interest reported by the account's provider for a calendar month. Future calendar months are rejected. The interest payout is the rounded amount reported by the provider, including carryover, already paid or payable for the period. APYE applies to the returned period, while interest YTD reflects the calendar year current when the observation is made, including for historical requests. Periods may be partial, and observedAt records successful retrieval and validation. Interest is omitted when it is unavailable for the account.

Path Params
string
required

Pass in the Spidr account ID

Query Params
string
required
^(?!0000)\d{4}-(0[1-9]|1[0-2])$

Calendar month to retrieve in YYYY-MM format.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json