Get Eligible Entitlements
Retrieve the entitlements a user is eligible for.
Available to: Traders (own records); organization administrators (any user in their organization)
Environments: Live
Rate Limit: No endpoint-specific limit
Return the entitlement IDs a user is eligible for under a given entitlement name. Pass the entitlementName. To query another user, an organization administrator also passes that user’s userId; omit userId to query yourself. The response returns the matching IDs in the entitlementIds array.
An entitlement counts as eligible only if the user meets the requirements it sets, which can include:
- An active Live account
- A minimum total net liquidation value across the user’s active accounts
- A current subscription plan (one of the entitlement’s plan categories, if it lists any)
- The entitlement’s use conditions
- A non-professional certification: the user must be non-professional and have signed it, unless you set
nonProSignedtotrue - Rules specific to the NinjaTrader Sim+ entitlements, which depend on whether the user has an active Live account and on their subscription plan (
simulationPlan), on whether they have an active Live account (simulationPlanBeta), or on whether they’ve submitted an application or hold an active paid subscription (simulationPlanPromo)
An entitlement with a use limit, a minimum number of days between uses, or a free-first-use offer can also have a next eligible date. It counts as eligible only on or after that date.
Common Failure Scenarios
- No entitlement the caller can access has the given
entitlementName, or the user doesn’t meet the requirements of any that do. Both returnHTTP 200with an emptyentitlementIdsarray and noerrorText. When the user is eligible for only some of them, the response lists only those. - The request includes
userIdand the caller isn’t an organization administrator. This returnsHTTP 401even whenuserIdis the caller’s own ID, so omituserIdto query yourself. - No user matches
userId, or you can’t access that user. Both returnHTTP 404with an empty body. Most organization administrators can’t access users outside their organization. - The caller’s user type, or the API key’s permissions, don’t include full access to the
Usersresource. This returnsHTTP 401with"Access is denied". entitlementNameis empty or longer than 64 characters, oruserIdisn’t greater than 0. These returnHTTP 400.- The request is sent to Demo. This endpoint runs on Live only, so Demo returns
HTTP 501.
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
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed