TAMP is a standalone API module for FA institutional trading and advisor approval workflows. It provides client account lookup, contract and account trading information, approval workflows, reference exchange rates, and enum dictionaries.
Authentication
Use a Bearer access token issued for the openapi audience. Send Authorization: Bearer <access_token> on every request. The token must include the scope required by the endpoint:
| Endpoints | Required scope |
|---|---|
| Account, contract, trading-constraint, estimated-buyable, FX, and metadata queries | api.tamp.basic:read |
| Approval preview, submission, and release | api.tamp.approval:write |
| Approval status queries | api.tamp.approval:read |
For institutional clients configured in TAMP mode, the master account is derived from authenticated client configuration. Do not pass masterAccountId as an HTTP parameter. These clients do not require the X-TIGR-UID header used by other FA trading modules. advisorUserName identifies the advisor initiating the transaction or query.
Response format
Responses contain code, reason, message, traceId, timestamp, and optional data. Always inspect code, including on HTTP 200. Zero indicates success; nonzero codes indicate business or gateway errors. Some business failures include partial results in data.
Amounts, quantities, and exchange rates are decimal strings. Enum values are case-sensitive, and spaces within a value are significant. Use the metadata endpoint for supported enum dictionaries.
Rate limits
Query endpoints have a default limit of 20 requests per second per client and endpoint. Approval preview, submission, and release have a default limit of 2 requests per second. Configured client-specific multipliers may increase the effective limits. Exceeding a limit returns HTTP 429 with RATE_LIMITED.
The estimated-buyable query accepts up to 10 instrument and currency pairs. The approval status query accepts up to 20 distinct numeric approval identifiers, supplied as a comma-separated string.
Encrypted account queries
Only the account query endpoint requires AES-256-GCM encryption. Encrypt the account query parameters together with a request timestamp in milliseconds and a unique nonce. Base64 encode IV || ciphertext || authentication tag and send it as the JSON payload field.
Use a 12-byte IV and a 16-byte authentication tag. The request timestamp may be up to 5 minutes in the past or 60 seconds in the future. Generate a new nonce for each request. Successful response data is encrypted in the same format; decrypt it with the provisioned client key before interpreting the account response.
The account query page includes the plaintext example and the request and response model details.
Reference exchange rates
Reference rates support cross-currency calculations; they are not executable or real-time FX conversion quotes. Supply sourceCurrencyList as a comma-separated string, or omit it to use the configured default currencies. Pairs without prices are omitted. A query with no available prices succeeds with rates: []. A pair of identical currencies has rate "1".
Approval workflows
Preview the transaction items, then submit the workflow using the same externalBusinessId, accountId, and advisorUserName. Reuse externalBusinessId only for retries of the same business operation. Supervisor release and workflow status queries use approvalId to identify the workflow.
BUY_SELL, RSP, and SWITCH items have different request fields and status models. Use item index to correlate requests with results. Approval status, order status, and fund-switch status are separate enums.