Skip to content

Create a sub-user

POST
/subusergen

Creates a sub-account linked to your account. A sub-user has its own API key, its own deposit address and a separate balance.

What matters about such accounts: the IP whitelist used is the parent's, not its own; the sub-user's key starts with the mock prefix; the generated deposit address is not activated by default; the google_id, email and name fields are fake, exist only for internal identification and are not real accounts, while the name and tag can be changed in the dashboard.

A sub-user can use every API method with its own key, and calculations run against its own balance.

The request body is an empty object {}; the Content-Type header is still required.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Request Body

application/json
JSON
{
}

Responses

The sub-user was created.

application/json
JSON
{
  
"user_id": 0,
  
"google_id": "SUB123456789012345678",
  
"email": "string",
  
"name": "string",
  
"deposit_address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
"api_key": "string",
  
"referral_code": "string",
  
"created_at": "string",
  
"referrer_user_id": 0,
  
"comment": "string"
}

Playground

Authorization
Headers
Body

Samples

Powered by VitePress OpenAPI