logo
Authentication

Delete SnapTrade user

delete
https://api.snaptrade.com/api/v1/snapTrade/deleteUser

Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.

Execute an API Request

Query
userIdstringrequired

SnapTrade User ID

Authorization
Request
Installation
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

object

Response when delete user is successful

statusstring

Delete status

userIdstring

SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user

1
{
2
"status": "deleted",
3
"userId": "snaptrade-user-123"
4
}