Methods

Whoami

Get current session

Private · Returns response

Method whoami

Get current session

Authentication required. Send authenticate with your API key, signature, and passphrase before calling this method. Sessions are bound to the WebSocket connection — reconnects must re-authenticate.

Request

This method takes no parameters.

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "whoami"
}

Response

On success the server replies with a JSON-RPC response matching the request id and the fields below.

apiKey*string
userId*string
permissions*string[]

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "apiKey": "string",
    "userId": "string",
    "permissions": [
      "string"
    ]
  }
}

On failure the server replies with a JSON-RPC error object matching the request id. See Errors for the full list of codes and recovery hints.