Connections

Delete connection

Changed on

Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the CONNECTION_DELETED webhook webhook to know when the deletion has been completed and the data has been removed.

delete/connection/{connectionId}

Request

  • Base URL
    https://api.snaptrade.com
  • URL
    https://api.snaptrade.com/connection/{connectionId}
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Path parameters

connectionIdstring uuid required

Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.

Example:87b24961-b51e-4db8-9226-f198f6518a89

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

Response

OK

detailstring

Connection queued for deletion; please wait for webhook for confirmation.

connection_idstring

The ID of the connection (brokerage authorization) that was scheduled for deletion.

Example response

{
  "detail": "Connection queued for deletion; please wait for webhook for confirmation.",
  "connection_id": "0b3ebefb-ed47-43df-cd8f-729a4420b5cf"
}

Changes