Use Your API Key

WAX API services provide interactive OpenAPI definitions, allowing you to enter your API Key and OAuth parameters for the Sandbox and Production environments (if applicable). Endpoints that require authentication are indicated by a lock icon.

No Auth

To determine the authentication requirements for a specific endpoint:

  1. Click the lock icon next to the endpoint you’d like to use.

  2. On the “Available authorizations” window, review the options available for the endpoint that you’ve selected (e.g., API Key or OAuth).

    Authentication Window

Endpoints that require an API key typically use the X-API-Key parameter, sent in the request Header.


curl -X GET \
  'https://api-trade.wax.io/IItem/GetAllItems/v1?app_id=32' \
  -H 'X-API-Key: 999d9ab99cde999a99cb9999df9999' \
  -H 'cache-control: no-cache' 

WAX ExpressTrade, WAX Marketplace, and other WAX services also provide OAuth enabled endpoints to make requests on behalf of a user. These endpoints use Bearer Authentication: Authorization: Bearer {access_token}


curl -X GET \
  https://api.opskins.com/ITest/TestAuthed/v1/ \
  -H 'Authorization: Bearer 452589dfgghhjjkl4885521236985' \
  -H 'cache-control: no-cache' 

Send a Test Request

In this example, we’ll use WAX ExpressTrade’s GetProfile endpoint to get your user id, display name, and other account information.

Request

curl -X GET \
  https://api-trade.wax.io/IUser/GetProfile/v1 \
  -H 'accept: application/json' \
  -H 'X-API-Key: 999d9ab99cde999a99cb9999df9999'

Response

{
    "status": 1,
    "time": 1565894553,
    "response": {
        "user": {
            "id": 6743505,
            "steam_id": "",
            "display_name": "User 6743505",
            "avatar": "https://www.gravatar.com/avatar/a57f183d4044fde00caffc5424731a2e?d=identicon&r=pg&s=32",
            "twofactor_enabled": true,
            "api_key_exists": true
        }
    }
}

What's Next