Skip to main content

Get reward rates per lot

GET 
/v1/partnership/lot-commission

Return the per-lot reward rates needed to calculate an expected reward for a selected client trading-account type and trading instrument. This operation accepts account_type and symbol; it does not accept a number of lots or return a final reward amount. multipliers contains the available reward-per-lot rates for the requested account type and instrument, keyed by lowercase tier name. To estimate the reward for your current tier, obtain tier_name from GET /v1/partnership/partner-tier/partner-state and convert it to lowercase (for example, Bronze to bronze). Look up that key in multipliers and multiply the returned rate by the number of lots. If the key is absent, the rate is unavailable in this response; do not treat it as zero.

Required scopes:

  • read: partnership.all:read or partnership.all.

Runtime restrictions:

  • Rates are retrieved using the partner's country.

Rules:

  • For revenue-share (spread-share) account types, a calculated total is an estimate and can vary with spread.
  • For fixed-per-lot account types, multipliers contains fixed per-lot rates.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • The operation is safe to retry. For a missing or inaccessible resource, verify the identifier and the current resource list before retrying.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError

Request​

Responses​

Successful response.