Entitlement Items

GET

https://demo.tradovateapi.com/v1/entitlement/items

GET

/v1/entitlement/items

1 const url = 'https://demo.tradovateapi.com/v1/entitlement/items?ids=101%2C202%2C303';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Retrieved

1 [
2   {
3     "title": "Premium Market Data Access",
4     "price": 49.99,
5     "name": "PremiumDataAccess",
6     "id": 101,
7     "startDate": {
8       "year": 2023,
9       "month": 1,
10       "day": 15
11     },
12     "discontinuedDate": {
13       "year": 2025,
14       "month": 12,
15       "day": 31
16     },
17     "duration": 12,
18     "durationUnits": "Month",
19     "autorenewal": true,
20     "legalEntityType": "NTCore",
21     "requiredNonProCertification": false,
22     "isUpgradable": true,
23     "freeForFirstTime": false,
24     "minDaysBetweenUse": 7,
25     "purchaseType": "CreditCard",
26     "rebateContractsThreshold": 5,
27     "useLimit": 100
28   }
29 ]

Fetches multiple Entitlement entities by id field

Authentication

AuthorizationBearer

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

Query parameters

idslist of longsRequired

Response

Entitlement

titlestring<=64 characters

pricedouble

namestring<=64 characters

idlongOptional

startDateobjectOptional

discontinuedDateobjectOptional

durationintegerOptional

durationUnitsenumOptional

Lifetime, Month, Quarter, Week, Year

autorenewalbooleanOptional

legalEntityTypeenumOptional

NTCore, SimPlusBeta

requiredNonProCertificationbooleanOptional

isUpgradablebooleanOptional

freeForFirstTimebooleanOptional

minDaysBetweenUseintegerOptional

purchaseTypeenumOptional

Any, CreditCard, LiveAccount

rebateContractsThresholdintegerOptional

useLimitintegerOptional