๐Ÿ“–Public requests

This documentation outlines the System API functionalities available through Whirl Privacy's service.

GET /system/status โ€“ System Status

Description: Fetches the system's operational status, including uptime and availability.

Parameters: None

Response:

{
  "error": [],
  "result": [
    {
        "status": "string"
    }
  ]
}

Error Handling: None

Example Code:

const fetch = require('node-fetch');

const BASE_URL = 'https://api.whirlprivacy.io/';

const getSystemStatus = async () => {
  try {
    const response = await fetch(`${BASE_URL}system/status`);
    const data = await response.json();

    console.log(data.result);
  } catch (error) {
    console.error('Error fetching system status:', error);
  }
};

getSystemStatus();

GET /system/assets โ€“ Supported Assets

Description: Provides a list of all cryptocurrencies or assets supported by WhirlPrivacy for transactions.

Parameters: None

Response:

{
  "error": [],
  "result": [
    {
        "supported": [
            {
                "ticker": "string",
                "decimals": "int",
                "address": "string",
                "min": "int",
                "max": "int",
                "minStr": "string",
                "maxStr": "string",
                "active": "boolean"
            },
            ...
        ]
    }
  ]
}

Error Handling: None

Example Code:

const fetch = require('node-fetch');

const BASE_URL = 'https://api.whirlprivacy.io/';

const getSupportedAssets = async () => {
 try {
    const response = await fetch(`${BASE_URL}system/assets`);
    const data = await response.json();

    console.log(data.result);
  } catch (error) {
    console.error('Error fetching system status:', error);
  }
};

getSupportedAssets();

Last updated