Skip to navigation

Get Plugin History

View as Markdown

Retrieve a user’s plugin history.

Available to: Traders (own records); organization administrators (any user in their organization)

Environments: Live

Rate Limit: No endpoint-specific limit

Return a user’s plugin history for a given entitlement as a JSON document. Pass the entitlementName. To read another user’s history, an organization administrator also passes that user’s userId; omit userId to read your own. The response returns the history in the jsonHistory field.

Common Failure Scenarios

  • The request includes userId and the caller isn’t an organization administrator. This returns HTTP 401 even when userId is the caller’s own ID, so omit userId to read your own history.
  • No user matches userId, or you can’t access that user. Both return HTTP 404 with an empty body. Most organization administrators can’t access users outside their organization.
  • The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource. This returns HTTP 401 with "Access is denied".
  • entitlementName is empty or longer than 64 characters, or userId isn’t greater than 0. These return HTTP 400.
  • The request is sent to Demo. This endpoint runs on Live only, so Demo returns HTTP 501.
  • The user has no plugin history for entitlementName. The call still succeeds (HTTP 200 with no errorText), and jsonHistory is the string "[]" (an empty JSON list).
  • The history lookup fails or times out. This returns HTTP 200 with the reason in errorText.

This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.

Error Messages

MessageResponseTrigger
"Entitlement Name should be specified"400entitlementName is empty or null.
"Entitlement Name should be no longer than 64"400entitlementName is longer than 64 characters.
"User Id should be greater than 0"400userId is included and isn’t greater than 0.
"mustBeOrganizationAdmin"401The request includes userId and the caller isn’t an organization administrator.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource.
(no message text)404No user matches userId, or you can’t access that user (most organization administrators can’t access users outside their organization).
"This endpoint should be called on live.tradovateapi.com"501Called on the Demo environment.
"Internal Error. Error ID: {id}"200 (in errorText)The history lookup failed unexpectedly. The error ID is generated per request.
"Request timeout. Error ID: {id}"200 (in errorText)The history lookup didn’t respond in time. The error ID is generated per request.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
entitlementNamestringRequired<=64 characters
userIdlongOptional

Response

GetPluginHistoryResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

jsonHistorystringOptional<=8388608 characters