Skip to navigation

Get Entitlement Eligibility Info

View as Markdown

Retrieve eligibility details for an entitlement.

Available to: Traders (own entitlement eligibility)

Environments: Live

Rate Limit: No endpoint-specific limit

Return the caller’s eligibility record for a given entitlementId, with the fields firstStartDate, lastStartDate, nextEligibleDate, lastExpirationDate, and usageCount.

Common Failure Scenarios

  • No entitlement matches entitlementId, or the caller can’t access it. Both return HTTP 404 with an empty body. The caller can’t access an entitlement that’s discontinued, not yet active, limited to organization administrators (when the caller isn’t one), or restricted by use conditions the caller doesn’t meet.
  • The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource. This returns HTTP 401 with "Access is denied".
  • entitlementId isn’t greater than 0. This returns HTTP 400.
  • The request is sent to Demo. This endpoint runs on Live only, so Demo returns HTTP 501.
  • The eligibility lookup finds no record for the caller and this entitlement. The call still succeeds (HTTP 200 with no errorText), but the response has none of the date fields or usageCount.
  • The eligibility lookup fails or times out. This returns HTTP 200 with the reason in errorText.

This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.

Error Messages

MessageResponseTrigger
"Entitlement Id should be greater than 0"400entitlementId isn’t greater than 0.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource.
(no message text)404No entitlement matches entitlementId, or the caller can’t see it.
"This endpoint should be called on live.tradovateapi.com"501Called on the Demo environment.
"Internal Error. Error ID: {id}"200 (in errorText)The eligibility lookup failed unexpectedly. The error ID is generated per request.
"Request timeout. Error ID: {id}"200 (in errorText)The eligibility lookup didn’t respond in time. The error ID is generated per request.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
entitlementIdlongRequired

Response

EligibilityInfoResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

lastStartDateobjectOptional
nextEligibleDateobjectOptional
lastExpirationDateobjectOptional
usageCountintegerOptional
firstStartDateobjectOptional