For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Support Center
OverviewAPIResources
OverviewAPIResources
  • REST API Endpoints
    • GETGet Timestamp
    • GETO IDC User Info
      • GETAdmin Alert Find
      • GETAdmin Alert Item
      • GETAdmin Alert Items
      • GETAdmin Alert List
      • GETAdmin Alert Suggest
      • GETClearing House Find
      • GETClearing House Item
      • GETClearing House Items
      • GETClearing House List
      • GETClearing House Suggest
      • GETClient App Find
      • GETClient App Item
      • GETClient App Items
      • GETClient App List
      • GETClient App Suggest
      • GETEntitlement Item
      • GETEntitlement Items
      • GETEntitlement List
      • GETOrder Strategy Type Find
      • GETOrder Strategy Type Item
      • GETOrder Strategy Type Items
      • GETOrder Strategy Type List
      • GETOrder Strategy Type Suggest
      • GETProperty Find
      • GETProperty Item
      • GETProperty Items
      • GETProperty List
      • GETProperty Suggest
Support Center
LogoLogo
REST API EndpointsConfiguration

Entitlement Item

GET
https://demo-d.tradovateapi.com/v1/entitlement/item
GET
/v1/entitlement/item
1const url = 'https://demo-d.tradovateapi.com/v1/entitlement/item?id=1';
2const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3
4try {
5 const response = await fetch(url, options);
6 const data = await response.json();
7 console.log(data);
8} catch (error) {
9 console.error(error);
10}
200Retrieved
1{
2 "title": "string",
3 "price": 1.1,
4 "name": "string",
5 "id": 1,
6 "startDate": {
7 "year": 1,
8 "month": 1,
9 "day": 1
10 },
11 "discontinuedDate": {
12 "year": 1,
13 "month": 1,
14 "day": 1
15 },
16 "duration": 1,
17 "durationUnits": "Lifetime",
18 "autorenewal": true,
19 "legalEntityType": "NTCore",
20 "requiredNonProCertification": true,
21 "isUpgradable": true,
22 "freeForFirstTime": true,
23 "minDaysBetweenUse": 1,
24 "purchaseType": "Any",
25 "rebateContractsThreshold": 1
26}

Fetches Entitlement entity by id field

Was this page helpful?
Previous

Entitlement Items

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

Entitlement
titlestring<=64 characters
pricedouble
namestring<=64 characters
idlong
startDateobject
discontinuedDateobject
durationinteger>=0
durationUnitsenum
Lifetime, Month, Quarter, Week, Year
Allowed values:
autorenewalboolean
legalEntityTypeenum
NTCore, NTTech
Allowed values:
requiredNonProCertificationboolean
isUpgradableboolean
freeForFirstTimeboolean
minDaysBetweenUseinteger
purchaseTypeenum
Any, CreditCard, LiveAccount
Allowed values:
rebateContractsThresholdinteger