incentive-programs

Get Incentives

List incentives with optional filters. Incentives are rewards programs for trading activity on specific markets.

get/incentive_programs

Query parameters

status'all' | 'active' | 'upcoming' | 'closed' | 'paid_out'

Status filter. Can be "all", "active", "upcoming", "closed", or "paid_out". Default is "all".

type'all' | 'liquidity' | 'volume' | 'margin_maker_volume'

Type filter. Can be "all", "liquidity", "volume", or "margin_maker_volume". Default is "all".

incentive_descriptionstring

Filter by exact incentive description.

limitinteger

Number of results per page. Defaults to 100. Maximum value is 10000.

cursorstring

Cursor for pagination

Response

Incentive programs retrieved successfully

next_cursorstring

Cursor for pagination to get the next page of results

Example response

{
  "incentive_programs": [
    {
      "target_size_fp": "10.00"
    }
  ]
}

Changes

Changed in 2 of the 17 revisions of this API.32

  • 6aec27d55fba12See the full diff
    • added the new margin_maker_volume enum value to the incentive_programs/items/incentive_type response property for the response status 200

      response-property-enum-value-added

    • added the new enum value margin_maker_volume to the query request parameter type

      request-parameter-enum-value-added

    • added the optional property incentive_programs/items/max_reward_per_account to the response with the 200 status

      response-optional-property-added

    • removed the optional property service from the response with the 400 status

      response-optional-property-removed

    • removed the optional property service from the response with the 500 status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog