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
      • GETAgreement Document Dependents
      • GETAgreement Document Item
      • GETAgreement Document Items
      • GETAgreement Document L Dependents
      • POSTAgreement Document Template Create
      • GETAgreement Document Template Find
      • GETAgreement Document Template Item
      • GETAgreement Document Template Items
      • GETAgreement Document Template List
      • GETAgreement Document Template Suggest
      • POSTAgreement Document Template Update
      • POSTCheck Duplicate
      • POSTCreate Sub Account Request
      • POSTCustomer Application Create
      • GETCustomer Application Dependents
      • GETCustomer Application Item
      • GETCustomer Application Items
      • GETCustomer Application L Dependents
      • POSTCustomer Application Update
      • POSTDuplicate Applicant By Address
      • GETPedsl Application Comment Dependents
      • GETPedsl Application Comment Item
      • GETPedsl Application Comment Items
      • GETPedsl Application Comment L Dependents
      • GETPedsl Application Dependents
      • GETPedsl Application Item
      • GETPedsl Application Items
      • GETPedsl Application L Dependents
      • POSTPrepare Agreement Documents
      • POSTSign Agreement Documents
      • POSTSign Non Pro Certification
      • POSTSign Sub Account Request
      • POSTSign User Document
      • POSTSimilar Applications Request
      • POSTStart Customer Application
      • POSTStart Pedsl Application
      • GETSub Account Request Dependents
      • GETSub Account Request Item
      • GETSub Account Request Items
      • GETSub Account Request L Dependents
      • GETSub Account Request List
      • POSTSubmit Applicant
      • POSTSubmit Customer Application Document
      • POSTUpdate Pedsl Application
      • GETUser Signed Document Dependents
      • GETUser Signed Document Item
      • GETUser Signed Document Items
      • GETUser Signed Document L Dependents
Support Center
LogoLogo
REST API EndpointsCustomer Applications

Agreement Document Template Suggest

GET
https://demo-d.tradovateapi.com/v1/agreementDocumentTemplate/suggest
GET
/v1/agreementDocumentTemplate/suggest
1const url = 'https://demo-d.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=t&l=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 {
3 "name": "string",
4 "timestamp": "2024-01-15T09:30:00Z",
5 "adminUseOnly": true,
6 "individual": true,
7 "joint": true,
8 "IRA": true,
9 "trust": true,
10 "LLC": true,
11 "ACH": true,
12 "externalRef": "string",
13 "highRisk": true,
14 "hedging": true,
15 "personalGuarantor": true,
16 "corporation": true,
17 "partnership": true,
18 "id": 1,
19 "professional": true,
20 "usaCustomer": true,
21 "usaJointCustomer": true,
22 "optionalSignature": true,
23 "otherEntityControl": true,
24 "genericSignWhitelist": true,
25 "priority": 1,
26 "clearingHouseId": 1,
27 "countryId": 1
28 }
29]
Fetches AgreementDocumentTemplate entities filtered by the presence of a specified text in one of their fields
Was this page helpful?
Previous

Agreement Document Template Update

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

tstringRequired
Text
lintegerRequired
Max number of entities

Response

AgreementDocumentTemplate
namestring<=64 characters
timestampdatetime
adminUseOnlyboolean
individualboolean
jointboolean
IRAboolean
IRA
trustboolean
LLCboolean
LLC
ACHboolean
ACH
externalRefstring<=8192 characters
highRiskboolean
hedgingboolean
personalGuarantorboolean
corporationboolean
partnershipboolean
idlong
professionalboolean
usaCustomerboolean
usaJointCustomerboolean
optionalSignatureboolean
otherEntityControlboolean
genericSignWhitelistboolean
priorityinteger
clearingHouseIdlong
countryIdlong