Alpaca Cash Interest API

openapi: 3.2.0
info:
  contact:
    email: support@alpaca.markets
    name: Alpaca Support
    url: https://alpaca.markets/support
  description: Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
  termsOfService: https://s3.amazonaws.com/files.alpaca.markets/disclosures/library/TermsAndConditions.pdf
  title: Broker Cash Interest API
  version: 1.1.1
servers:
- description: Sandbox endpoint
  url: https://broker-api.sandbox.alpaca.markets
- description: Production endpoint
  url: https://broker-api.alpaca.markets
security:
- BasicAuth: []
tags:
- name: Cash Interest
paths:
  /v1/cash_interest/apr_tiers:
    get:
      description: List all available APR tiers. These tiers may be assigned to an account, and will be used to determine the interest rate paid on uninvested cash balances.
      operationId: get-v1-list-apr-tiers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAPRTiersResponse'
          description: Successful response, returns a list of APR tiers or none if no tiers are available.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized. Please check your API key and try again.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Too many requests. Please wait a moment and try again.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: A server error occurred. Please contact Alpaca.
      summary: List APR Tiers
      tags:
      - Cash Interest
  /v1/reporting/eod/cash_interest:
    get:
      description: This API retrieves a list of cash interest details for the given date(s) for a single account or all accounts. End-of-day (EOD) details are typically accessible after 8:00pm Eastern Time (ET) and reflect that day's ending state across cash balances, accrued interest, accrued fees, as well as additional ancillary details.
      operationId: get-v1-get-eod-cash-interest-report
      parameters:
      - description: Account globally unique identifier. If not provided, the report will be generated for all accounts.
        in: query
        name: account_id
        required: false
        schema:
          format: uuid
          type: string
      - description: A date in the format YYYY-MM-DD. If not provided, the report will be generated for the most recent date this report is available.
        in: query
        name: date
        required: false
        schema:
          format: date
          type: string
      - description: A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use `before` value. If neither is provided the most recent available date is used for both `before` and `after`.
        in: query
        name: after
        required: false
        schema:
          format: date
          type: string
      - description: A date in the format YYYY-MM-DD, valid only if account_id is provided and date is not provided. If not provided, this will use the most recent available date.
        in: query
        name: before
        required: false
        schema:
          format: date
          type: string
      - description: The direction to use for sorting responses, either `asc` or `desc`. Only valid for account_id queries, for which only sorting by date is supported. Defaults to `desc`.
        in: query
        name: direction
        required: false
        schema:
          type: string
      - description: The page size, used for paginating responses. Defaults to 1000, with a maximum of 10,000.
        in: query
        name: page_size
        required: false
        schema:
          default: 1000
          maximum: 10000
          minimum: 1
          type: integer
      - description: A token used to retrieve the next page for paginated queries. If provided the response will begin at the next page of the results for the response from which the `next_page_token` is used.
        in: query
        name: page_token
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EoDCashInterestReportResponse'
          description: Successful response, returns a list of daily interest accruals and an optional next page token.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: A client error occurred. Please check the provided request parameters and try again.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized. Please check your API key and try again.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Too many requests. Please wait a moment and try again.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: A server error occurred. Please contact Alpaca.
      summary: Retrieve EOD Cash Interest Details
      tags:
      - Cash Interest
components:
  schemas:
    Error:
      properties:
        code:
          description: Alpaca error code, such as `40310000`. Usually the HTTP status code followed by a five-digit suffix. Several errors can share the same code, so check `message` for the specific reason.
          type: number
        message:
          description: Human-readable reason for the rejection.
          type: string
      required:
      - code
      - message
      title: Error
      type: object
    DailyCashInterest:
      properties:
        account_accrued_interest:
          example: '1.2152'
          format: decimal
          type: string
        account_id:
          example: 02e5c5ba-36d2-467a-8699-81dc24271291
          format: uuid
          type: string
        account_rate_bps:
          example: 423
          type: integer
        apr_tier_id:
          example: 13d149c8-d620-43e0-978b-88af8abb2ef1
          format: uuid
          type: string
        apr_tier_name:
          example: gold
          type: string
        cash_balance:
          example: '10485.76'
          format: decimal
          type: string
        correspondent_fee:
          example: '0.0718'
          format: decimal
          type: string
        correspondent_rate_bps:
          example: 25
          type: integer
        currency:
          example: USD
          type: string
        date:
          example: '2024-09-27'
          format: date
          type: string
      type: object
    APRTier:
      properties:
        account_rate_bps:
          description: The annualized account interest rate, in basis points.
          example: 450
          type: integer
        correspondent_rate_bps:
          description: The annualized correspondent fee rate, in basis points.
          example: 25
          type: integer
        created_at:
          description: The timestamp the APR tier was created, in RFC 3339 format.
          example: '2024-09-16T20:06:32.207729Z'
          format: date-time
          type: string
        currency:
          description: The currency of the APR tier
          example: USD
          type: string
        details:
          $ref: '#/components/schemas/APRTierDetails'
        id:
          description: The unique identifier of the APR tier
          example: 150df7eb-31e7-46b3-8848-a54ca21ff3bc
          format: uuid
          type: string
        is_default:
          description: 'Whether this is the default APR tier for its currency. Each currency has at most one default tier. When true, an account that signs the required Alpaca Customer Agreement revision without providing cash_interest may be automatically enrolled in this tier. Do not rely on a default tier for enrollment; always set apr_tier_name explicitly via Create Account or Update Account.

            '
          example: false
          type: boolean
        name:
          description: The unique name of the APR tier
          example: gold
          type: string
        updated_at:
          description: The timestamp of the last update to the APR tier, in RFC 3339 format.
          example: '2024-09-16T20:06:32.207729Z'
          format: date-time
          type: string
      type: object
    EoDCashInterestReportResponse:
      properties:
        interest:
          items:
            $ref: '#/components/schemas/DailyCashInterest'
          type: array
        next_page_token:
          example: 293639be-8807-423f-b00d-68c781e8bb56
          type:
          - string
          - 'null'
      type: object
    ListAPRTiersResponse:
      description: 'Response to a successful request for a list of APR tiers.

        '
      properties:
        apr_tiers:
          description: All configured APR tiers available for assignment to accounts
          items:
            $ref: '#/components/schemas/APRTier'
          type: array
      type: object
    APRTierDetails:
      description: 'Additional details of the APR tier

        '
      properties:
        as_of:
          description: 'The date on which the total balance was recorded, at the end of the day. YYYY-MM-DD format.

            '
          example: '2024-09-27'
          format: date
          type: string
        total_accounts:
          description: The total number of accounts assigned this APR tier.
          example: 42
          type: integer
        total_balance:
          description: The total balance of funds in this APR tier.
          example: '10485.76'
          format: decimal
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
x-readme:
  explorer-enabled: true
  proxy-enabled: false