Get Earnings

Request

Security

HTTPBearer

Path

pocket_idstring, (uuid)(Pocket Id)required

Query

periodstring(Period)

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).

Default:"all-time"

Enum:"ytd""mtd""wtd""all-time""range"

date_fromstring or null(Date From)

Any of:

string (date)

date_tostring or null(Date To)

Any of:

string (date)

x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v2/pockets/{pocket_id}/earnings/?period=ytd&date_from=2019-08-24&date_to=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json

earningsobject(Amount)required

date_fromstring or null(Date From)required

Any of:

string (date)

date_tostring, (date)(Date To)required

pricing_timestampstring or null(Pricing Timestamp)

Any of:

string (date-time)

appreciation_per_secondDecimal (string) or null

Any of:

string(Decimal)

Response

{
  "earnings": {
    "value": 13000,
    "currency": "USD",
    "formatted": "$130.00"
  },
  "date_from": "2025-04-01",
  "date_to": "2025-05-01"
}

Get Earnings

Request

Path

Query

Headers

Responses

Was this helpful?