Getting Started

Before you get started, please reach out to sign a Member agreement, and you will then receive a WXET issued API key in order to transact with the platform.

Before you start

List the prerequisites that are required or recommended.

Make sure that:

There are is no staging platform

Quick Start

Once you've received an API key, the following steps will confirm your account is active and ready to participate on the marketplace.

Confirm you can fetch information about your account.

curl -X GET --location "https://api.wxet.org/v2/account/" 
   -H "Authorization: <API-Token>"

This should return back a valid json response that looks something like:

   {
      "uuid": "cfc1e359c29a47b08590692bf916635a",
      "name": "general-health-inc",
      "blocked": false,
      "created": "2024-08-05T09:07:39.075716Z",
      "last_seen": "2024-08-05T09:07:39.075716Z",
      "ledger_accounts": {
         "wallet": {
            "uuid": "754dc3fe8b40459891905b4321ea13a5",
            "display_name": "Wallet_cfc1e359c29a47b08590692bf916635a",
            "account_type": "wa_wallet",
            "normal_balance": -1,
            "reference_uuid": "cfc1e359c29a47b08590692bf916635a",
            "currency": "test",
            "balance": 0
         },
         "held": {...},
         "credit_line": {...}
      }
   }

You'll be able to see some basic information about the Account, none of this information is modifiable by you. It can be used as a snapshot of account details, and most importantly: it allows you to see financial details about your Ledger Accounts. More on that in the next section Ledger Accounts & Budget Pools

Last modified: 01 October 2024