Experimental endpoints

Add a Trade Detection subscription

Changed on

Adds or restores a Trade Detection subscription for a connected brokerage account. This endpoint requires userId and userSecret in addition to the partner signature.

post/snapTrade/tradeDetection/subscriptions

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/snapTrade/tradeDetection/subscriptions
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Query parameters

userIdstring required

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

Example:snaptrade-user-123
userSecretstring required

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Request body

account_idstring uuid required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

check_interval_secondsinteger required

How often the subscribed account should be checked for new trades. Must match an active Trade Detection plan.

Example request

{
  "account_id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
  "check_interval_seconds": 300
}

Response

Restored an existing cancelled Trade Detection subscription

account_idstring uuid required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

coststring required

Monthly subscription cost as a decimal string.

check_interval_secondsinteger required

How often the subscribed account is checked for new trades.

Example response

{
  "account_id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
  "cost": "100.00",
  "check_interval_seconds": 300
}

Changes

  • efd73af6c911Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

  • 07c9022b410aRevision changes
    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status