# Get Earnings

Endpoint: GET /api/v2/pockets/{pocket_id}/earnings/
Version: Version: b6359d9a
Security: HTTPBearer

## Path parameters:

  - `pocket_id` (string, required)

## Query parameters:

  - `period` (string)
    The period to fetch earnings for. Can be one of

 * ytd (Year-to-date)
 * mtd (Month-to-date)
 * wtd (Week-to-date)
 * all-time
 * range

When 'range' is chosen, you need to specify 'date_from' and 'date_to' (inclusive).
    Enum: "ytd", "mtd", "wtd", "all-time", "range"

  - `date_from` (any)

  - `date_to` (any)

## Header parameters:

  - `x-jiko-idempotency` (string, required)

  - `x-jiko-signature` (string, required)

## Response 200 fields (application/json):

  - `earnings` (object, required)

  - `earnings.value` (integer, required)
    USD values are always in cents.

  - `earnings.currency` (string, required)

  - `earnings.formatted` (string)

  - `date_from` (any, required)

  - `date_to` (string, required)

## Response 422 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)