Authentication

Register user

Changed on

Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.

post/snapTrade/registerUser

Request

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

Request body

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 request

{
  "userId": "snaptrade-user-123"
}

Response

OK

userIdstring

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.

userSecretstring

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 response

{
  "userId": "snaptrade-user-123",
  "userSecret": "adf2aa34-8219-40f7-a6b3-60156985cc61"
}

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 integer 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 integer for status