> ## Documentation Index > Fetch the complete documentation index at: https://docs.architect.exchange/llms.txt > Use this file to discover all available pages before exploring further. # Get reward accruals ## OpenAPI ````yaml openapi/api-gateway.json GET /mmlp/v2/reward-accruals openapi: 3.1.0 info: title: ax-api-gateway description: '' license: name: '' version: 16.3.0 servers: - url: https://gateway.architect.exchange/api security: [] tags: - name: api-gateway description: API gateway paths: /mmlp/v2/reward-accruals: get: tags: - mmlp operationId: list_reward_accruals parameters: - name: account_id in: query description: The trading account to read. Omit for the caller's default account. required: false schema: type: - string - 'null' - name: limit in: query description: Page size; defaults to `DEFAULT_PAGE_SIZE`. required: false schema: type: - integer - 'null' format: int32 minimum: 0 - name: offset in: query description: Rows to skip; defaults to 0. required: false schema: type: - integer - 'null' format: int32 minimum: 0 - name: symbol in: query description: Restrict to one instrument symbol. required: false schema: type: - string - 'null' - name: payout_status in: query description: Restrict to rewards at one point in the payout lifecycle. required: false schema: oneOf: - type: 'null' - $ref: '#/components/schemas/MmlpV2PayoutStatus' - name: start_date in: query description: Inclusive `YYYY-MM-DD` lower bound on the epoch day. required: false schema: type: - string - 'null' format: date - name: end_date in: query description: Inclusive `YYYY-MM-DD` upper bound on the epoch day. required: false schema: type: - string - 'null' format: date responses: '200': description: The caller's reward accruals, with totals and a per-day trend content: application/json: schema: $ref: '#/components/schemas/GetMmlpV2RewardAccrualsResponse' security: - session_token: [] components: schemas: MmlpV2PayoutStatus: type: string description: |- Where a reward stands on its way to being paid. - `accrued` — earned on the most recently closed epoch, not yet put up for approval. - `awaiting` — submitted for approval. - `approved` — cleared for payment. - `paid` — credited to the account. - `retained` — forfeited and kept by the exchange, because the reward fell below the minimum payout. Not a stage on the way to `paid`. enum: - accrued - awaiting - approved - paid - retained GetMmlpV2RewardAccrualsResponse: allOf: - $ref: '#/components/schemas/LimitOffsetPage' description: >- `total_count` is the filtered set's size, which `accruals` pages over. - type: object required: - summary - trend - symbols - window - accruals properties: accruals: type: array items: $ref: '#/components/schemas/MmlpV2RewardAccrual' description: One page of the filtered set, newest epoch first. summary: $ref: '#/components/schemas/MmlpV2RewardSummary' description: Totals over the whole filtered set, not just the page. symbols: type: array items: type: string description: >- Every symbol you have ever accrued on, over the whole ledger — so a caller can tell which instruments engaged the program without reading every page. trend: type: array items: $ref: '#/components/schemas/MmlpV2AccrualTrendPoint' description: Per-day totals over the whole filtered set, not just the page. window: $ref: '#/components/schemas/MmlpV2AccrualWindow' description: Inclusive epoch-day bounds of the whole ledger, for date inputs. LimitOffsetPage: type: object description: |- Page metadata for limit/offset paged responses. This is intended for response bodies (not query params). required: - total_count - limit - offset properties: limit: type: integer format: int32 minimum: 0 offset: type: integer format: int32 minimum: 0 total_count: type: integer format: int64 minimum: 0 MmlpV2RewardAccrual: type: object description: |- One reward for a single epoch, symbol, and account: `raw_reward_usd` is the share before the per-account payout cap, `cap_adjustment_usd` is what the cap added or removed, and `final_accrued_usd` is the payable amount. required: - id - epoch_start_ts - epoch_end_ts - symbol - raw_reward_usd - cap_adjustment_usd - final_accrued_usd - account_share - payout_status properties: account_share: type: string description: >- Your share of the instrument's reward pool for this epoch, in `[0, 1]`: a bonus-weighted average of your share of all makers' scores over the scored minutes. `raw_reward_usd` is this share of the pool, before the cap. Zero once the epoch's scores are no longer available. cap_adjustment_usd: type: string epoch_end_ts: type: string format: date-time epoch_start_ts: type: string format: date-time final_accrued_usd: type: string id: type: string payout_status: $ref: '#/components/schemas/MmlpV2PayoutStatus' raw_reward_usd: type: string symbol: type: string MmlpV2RewardSummary: type: object description: Headline totals over the filtered ledger. required: - accrued_today_usd - awaiting_approval_usd - paid_this_month_usd - retained_usd properties: accrued_today_usd: type: string awaiting_approval_usd: type: string paid_this_month_usd: type: string retained_usd: type: string MmlpV2AccrualTrendPoint: type: object description: The caller's reward totals for one symbol on one epoch day. required: - epoch_day - symbol - accrued_usd - paid_usd properties: accrued_usd: type: string epoch_day: type: string format: date description: The epoch day, as `YYYY-MM-DD`. paid_usd: type: string symbol: type: string MmlpV2AccrualWindow: type: object description: |- Inclusive `YYYY-MM-DD` epoch-day bounds of the unfiltered ledger; both empty when there are no rewards. required: - min_day - max_day properties: max_day: type: string min_day: type: string securitySchemes: session_token: type: http scheme: bearer description: User session token ````