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 Items

GET
https://demo-d.tradovateapi.com/v1/entitlement/items
GET
/v1/entitlement/items
1const url = 'https://demo-d.tradovateapi.com/v1/entitlement/items?ids=%5B1%5D';
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 {
3 "title": "string",
4 "price": 1.1,
5 "name": "string",
6 "id": 1,
7 "startDate": {
8 "year": 1,
9 "month": 1,
10 "day": 1
11 },
12 "discontinuedDate": {
13 "year": 1,
14 "month": 1,
15 "day": 1
16 },
17 "duration": 1,
18 "durationUnits": "Lifetime",
19 "autorenewal": true,
20 "legalEntityType": "NTCore",
21 "requiredNonProCertification": true,
22 "isUpgradable": true,
23 "freeForFirstTime": true,
24 "minDaysBetweenUse": 1,
25 "purchaseType": "Any",
26 "rebateContractsThreshold": 1
27 }
28]

Fetches multiple Entitlement entities of id field

Was this page helpful?
Previous

Entitlement List

Next
Built with

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
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