> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://partner.ninjatrader.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server. # Agreement Document Template Suggest GET https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest ### Search agreement document templates by text. **Available to:** All authenticated users. Templates marked `adminUseOnly` are visible only to internal NinjaTrader administrators. **Environments:** Demo, Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Retrieve agreement document templates whose fields contain the text you pass in the `t` parameter, up to the maximum number of results you set with the `l` parameter. Agreement document templates define the customer agreement documents that are generated during application onboarding. Use this endpoint when you don't know a template's exact name — for exact-name lookups, [`agreementDocumentTemplateFind`](/api/rest-api-endpoints/users/agreement-document-template-find) is more precise. **Related Endpoints** - Use [`agreementDocumentTemplateList`](/api/rest-api-endpoints/users/agreement-document-template-list) to retrieve all visible templates without filtering. - Use [`agreementDocumentTemplateItems`](/api/rest-api-endpoints/users/agreement-document-template-items) to fetch specific templates by ID. Reference: https://partner.ninjatrader.com/connect/api/rest-api-endpoints/users/agreement-document-template-suggest ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: connect version: 1.0.0 paths: /agreementDocumentTemplate/suggest: get: operationId: agreement-document-template-suggest summary: Agreement Document Template Suggest description: >- ### Search agreement document templates by text. **Available to:** All authenticated users. Templates marked `adminUseOnly` are visible only to internal NinjaTrader administrators. **Environments:** Demo, Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Retrieve agreement document templates whose fields contain the text you pass in the `t` parameter, up to the maximum number of results you set with the `l` parameter. Agreement document templates define the customer agreement documents that are generated during application onboarding. Use this endpoint when you don't know a template's exact name — for exact-name lookups, [`agreementDocumentTemplateFind`](/api/rest-api-endpoints/users/agreement-document-template-find) is more precise. **Related Endpoints** - Use [`agreementDocumentTemplateList`](/api/rest-api-endpoints/users/agreement-document-template-list) to retrieve all visible templates without filtering. - Use [`agreementDocumentTemplateItems`](/api/rest-api-endpoints/users/agreement-document-template-items) to fetch specific templates by ID. tags: - Users parameters: - name: t in: query description: Text required: true schema: type: string - name: l in: query description: Max number of entities required: true schema: type: integer - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: AgreementDocumentTemplate content: application/json: schema: type: array items: $ref: '#/components/schemas/AgreementDocumentTemplate' servers: - url: https://live.tradovateapi.com/v1 description: https://live.tradovateapi.com/v1 components: schemas: AgreementDocumentTemplate: type: object properties: id: type: integer format: int64 name: type: string timestamp: type: string format: date-time adminUseOnly: type: boolean individual: type: boolean joint: type: boolean IRA: type: boolean description: IRA trust: type: boolean LLC: type: boolean description: LLC ACH: type: boolean description: ACH externalRef: type: string highRisk: type: boolean hedging: type: boolean personalGuarantor: type: boolean corporation: type: boolean partnership: type: boolean professional: type: boolean usaCustomer: type: boolean usaJointCustomer: type: boolean optionalSignature: type: boolean otherEntityControl: type: boolean genericSignWhitelist: type: boolean priority: type: integer clearingHouseId: type: integer format: int64 countryId: type: integer format: int64 organizationId: type: integer format: int64 templatePreviewWhitelist: type: boolean required: - name - timestamp - adminUseOnly - individual - joint - IRA - trust - LLC - ACH - externalRef - highRisk - hedging - personalGuarantor - corporation - partnership title: AgreementDocumentTemplate securitySchemes: bearer_access_token: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json [ { "name": "Standard Customer Agreement", "timestamp": "2024-01-15T09:30:00Z", "adminUseOnly": false, "individual": true, "joint": true, "IRA": false, "trust": false, "LLC": false, "ACH": true, "externalRef": "STD-CUST-AGMT-2024", "highRisk": false, "hedging": false, "personalGuarantor": false, "corporation": false, "partnership": false, "id": 1024, "professional": false, "usaCustomer": true, "usaJointCustomer": true, "optionalSignature": false, "otherEntityControl": false, "genericSignWhitelist": false, "priority": 10, "clearingHouseId": 15, "countryId": 840, "organizationId": 2001, "templatePreviewWhitelist": false } ] ``` **SDK Code** ```python import requests url = "https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest" querystring = {"t":"customer agreement","l":"5"} payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/agreementDocumentTemplate/suggest?t=customer+agreement&l=5")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```