💰Wallet Routes

Documentation for the Stelo Finance wallet routes

The /wallet routes are used for retrieving/updating any information pertaining to your currently active wallet.

General Wallet Routes

All General Wallet Routes utilize the wallet auth, please refer to Auth to learn more.

Get assets in wallet

GET https://api.stelo.finance/wallet/assets

Get a list of all the assets in your active wallet.

200: OK List of assets

[
  {
    "asset": {
      "id": 0,
      "name": "string",
      "value": 0
    },
    "quantity": 0
  }
]

Create a transaction

POST https://api.stelo.finance/wallet/transactions

Send one or more assets to another wallet.

Request Body

Name	Type	Description
recipient*	string	Wallet address or username of the player you want to send the transaction to
type	integer	Clarification on what type `recipient` is. 0 for username, 1 for wallet address, 2 for wallet id. Defaults to 0.
memo	string	64 characters max, just used as a memo or note to the transaction
assets*	object	an object whose keys are the assets you want to send, and their values are integers of the quantity you want to send of that asset.

400: Bad Request

G000: Invalid JSON Body

I001: Invalid Asset

201: Created Transaction created

The session JWT is returned in a cookie named 'ujwt'. You need to include this cookie in subsequent requests.

404: Not Found

W000: Wallet Not Found

U003: User Not Found

Get transactions

GET https://api.stelo.finance/wallet/transactions

Get a list of all the assets in your active wallet.

Query Parameters

Name	Type	Description
limit	integer	0-100, defaults to 10
offset	integer	0-1000

200: OK List of transactions

[
  {
    "id": 0,
    "sending_wallet_id": 0,
    "receiving_wallet_id": 0,
    "sending_wallet_address": "string",
    "receiving_wallet_address": "string",
    "sending_username": "string", // optional
    "receiving_username": "string", //optional
    "created_at": "2022-11-26T19:31:09.602Z",
    "memo": "string",
    "assets": [
      {
        "quantity": 0,
        "asset": {
          "id": 0,
          "name": "string",
          "value": 0
        }
      }
    ]
  }
]

400: Bad Request

G002: Invalid URL Query

Handling assigned users

All Handling assigned users routes utilize the user auth, please refer to Auth to learn more.

Assign user to wallet

POST https://api.stelo.finance/wallet/users

Assign a user read/write permissions to your active wallet (note, you must be the owner, if your active wallet isn't owned by you you'll get a 400).

Request Body

Name	Type	Description
username*	string

400: Bad Request

G000: Invalid JSON Body

U003: User Not Found

W003: User Already Assigned To Wallet

200: OK User assigned to wallet

The session JWT is returned in a cookie named 'ujwt'. You need to include this cookie in subsequent requests.

403: Forbidden

W006: Wallet Not Owned

Remove user from wallet

DELETE https://api.stelo.finance/wallet/users/{userid}

Remove a user's access to one of your owned wallets.

Path Parameters

Name	Type	Description
userid*	integer

200: OK User removed from wallet

400: Bad Request

G001: Invalid URL Parameter

W006: Wallet Not Owned

Get assigned users

GET https://api.stelo.finance/wallet/users

Get a list of users assigned to your active wallet.

200: OK List of assigned users

[
  {
    "id": 0,
    "username": "string"
  }
]

Transfer wallet ownership

PUT https://api.stelo.finance/wallet/owner

Assign a new user as the owner of your active wallet. Note, the user must be first assigned to the wallet.

Request Body

Name	Type	Description
user_id*	string

400: Bad Request

G000: Invalid JSON Body

W007: User Not Assigned

200: OK New owner assigned

Handling wallet sessions

All Handling wallet sessions routes utilize the user auth. Please refer to Auth to learn more.

Create wallet session

POST https://api.stelo.finance/wallet/sessions

Create a wallet session. You'll be returned a key that third parties or apps can use to gain read/write access, similar to assigning a user, but only this key is needed for access.

Request Body

Name	Type	Description
name	string	custom identifier for the session

400: Bad Request

G000: Invalid JSON Body

201: Created Wallet session created

{
  "token": "string"
}

Get wallet sessions

GET https://api.stelo.finance/wallet/sessions

Get a list of open wallet sessions on your active wallet.

200: OK List of assigned users

[
  {
    "id": 0,
    "wallet_id": 0,
    "name": "string"
  }
]

Delete a wallet session

DELETE https://api.stelo.finance/wallet/sessions/{sessionid}

Delete a wallet session, revoking the ability for it to be refreshed.

Path Parameters

Name	Type	Description
sessionid*	integer

200: OK Wallet session deleted

404: Not Found

W005: Session Not Found

400: Bad Request

G001: Invalid URL Parameter

Delete wallet sessions

DELETE https://api.stelo.finance/wallet/sessions

Delete all wallet sessions

200: OK All wallet sessions deleted

Webhooks

The Webhooks routes use user auth. Please refer to Auth to learn more.

Set wallet webhook

PUT https://api.stelo.finance/wallet/webhook

Put a webhook on your active wallet. Refer to Webhooks to understand this functionality.

Request Body

Name	Type	Description
webhook	string	Valid URL

200: OK Webhook set

400: Bad Request

G000: Invalid JSON Body

403: Forbidden

W006: Wallet Not Owned

Remove webhook from wallet

DELETE https://api.stelo.finance/wallet/webhook

Removes whatever webhook is currently set on the active wallet.

200: OK Webhook removed

403: Forbidden

W006: Wallet Not Owned

Delete Wallet

The Delete Wallet route uses user auth. Please refer to Auth to learn more.

Delete active wallet

DELETE https://api.stelo.finance/wallet

Deletes the active wallet, transfers all its content to your primary wallet and changes your active wallet to your primary wallet. (Can only be done by wallet owner)

200: OK Wallet deleted

400: Bad Request

W008: Can't Delete Primary Wallet

403: Forbidden

W006: Wallet Not Owned