Entitlement Item

GET

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

GET

/v1/entitlement/item

1 const url = 'https://demo.tradovateapi.com/v1/entitlement/item?id=123456789';
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   "title": "Premium Market Data Access",
3   "price": 49.99,
4   "name": "MarketDataPro",
5   "id": 123456789,
6   "startDate": {
7     "year": 2023,
8     "month": 7,
9     "day": 1
10   },
11   "discontinuedDate": {
12     "year": 2025,
13     "month": 12,
14     "day": 31
15   },
16   "duration": 12,
17   "durationUnits": "Month",
18   "autorenewal": true,
19   "legalEntityType": "NTCore",
20   "requiredNonProCertification": false,
21   "isUpgradable": true,
22   "freeForFirstTime": false,
23   "minDaysBetweenUse": 7,
24   "purchaseType": "CreditCard",
25   "rebateContractsThreshold": 100,
26   "useLimit": 10
27 }

Fetches Entitlement entity by id field

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

durationUnitsenum

Lifetime, Month, Quarter, Week, Year

autorenewalboolean

legalEntityTypeenum

NTCore, SimPlusBeta

requiredNonProCertificationboolean

isUpgradableboolean

freeForFirstTimeboolean

minDaysBetweenUseinteger

purchaseTypeenum

Any, CreditCard, LiveAccount

rebateContractsThresholdinteger

useLimitinteger