HomeDocumentationAPI Reference
Log In

Get Invite Code

Method Name

private/get_invite_code

Get a shareable invite code for account which can be shared with friends.
Required minimum session key permission level is read_only

Parameters

wallet string required
Wallet address of the user

Response

id string or integer required
result object required
result.code string required
Invite code
result.remaining_uses integer required
Remaining uses of the invite code. Unlimited use codes will return -1

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}