GameShift

https://docs.gameshift.dev/docs/
Admin
GameShift is a platform offering APIs and a console for game developers to manage in-game items,...
Tokens:61,201
Snippets:257
Trust Score:5.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Lending Grant Response Example

Source: https://docs.gameshift.dev/docs/working-with-game-assets

Example JSON response received upon successfully creating a lending grant. It includes identifiers for the grant, item, owner, borrower, expiration, creation timestamp, status, and environment.

```json
{
  "id": "string",
  "itemId": "string",
  "ownerReferenceId": "string",
  "borrowerReferenceId": "string",
  "expiration": "2023-12-14T22:35:14.292Z",
  "created": "2023-12-14T22:35:14.292Z",
  "status": "Pending",
  "environment": "Development"
}
```

--------------------------------

### Register User Response - JSON

Source: https://docs.gameshift.dev/docs/gameshift-interaction

Example JSON response after successfully registering a user. It confirms the provided referenceId and email, and implicitly indicates wallet provisioning.

```json
{
  "referenceId": "exampleReferenceId",
  "email": "user@example.com"
}
```

--------------------------------

### User Owned Items List - JSON

Source: https://docs.gameshift.dev/docs/gameshift-interaction

Example JSON response detailing a paginated list of items owned by a user. Includes details for both Currencies and Unique Assets, with metadata for pagination.

```json
{
  "data": [
    {
      "type": "Currency",
      "item": {
        "id": "string",
        "mintAddress": "string",
        "name": "string",
        "symbol": "string"
      },
      "quantity": "1254"
    },
    {
      "type": "UniqueAsset",
      "item": {
        "id": "string",
        "attributes": [
          {
            "traitType": "string",
            "value": "string"
          }
        ],
        "created": 0,
        "name": "string",
        "collection": {
          "id": "string",
          "name": "string",
          "description": "string",
          "environment": {},
          "imageUrl": "string",
          "imported": true,
          "mintAddress": "string",
          "created": 0,
          "stats": {
            "numMinted": 0,
            "floorPrice": 0,
            "numListed": 0,
            "numOwners": 0
          }
        },
        "description": "string",
        "environment": {},
        "imported": true,
        "imageUrl": "string",
        "status": "Unprocessed",
        "forSale": true,
        "mintAddress": "string",
        "owner": {
          "address": "string",
          "referenceId": "string"
        },
        "price": {
          "currencyId": "USDC",
          "naturalAmount": "0"
        }
      }
    }
   ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1
  }
}
```

--------------------------------

### User Currency Balance Response (JSON)

Source: https://docs.gameshift.dev/docs/working-with-game-assets

Example JSON response when viewing a user's currency balances. It includes a paginated list of currencies with their respective quantities and metadata about the pagination.

```json
{
  "data": [
    {
      "type": "Currency",
      "item": {
        "id": "SOL",
        "mintAddress": "11111111111111111111111111111111",
        "name": "SOL",
        "symbol": "SOL"
      },
      "quantity": "1.09796072"
    },
    {
      "type": "Currency",
      "item": {
        "id": "USDC",
        "mintAddress": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
        "name": "USD Coin",
        "symbol": "USDC"
      },
      "quantity": "25.5"
    },
    {
      "type": "Currency",
      "item": {
        "id": "b3e6a7ff-d692-4843-8455-9f3777aae146",
        "mintAddress": "DuhbFTUND4Zv75bWbXtXthg2GLNNRvDGziYGZCR9EXFk",
        "name": "Example Currency",
        "symbol": "EXMP"
      },
      "quantity": "0"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1,
    "totalResults": 3
  }
}
```

--------------------------------

### Fetch User Owned Items (cURL)

Source: https://docs.gameshift.dev/docs/onboard-your-users

Retrieves a list of items owned by a specific user using a GET request to the /nx/users/{userId}/items endpoint. Requires the user's ID (referenceId) and an API key. Returns a paginated list of currencies and unique assets.

```cURL
curl --request GET \
     --url https://api.gameshift.dev/nx/users/exampleReferenceId/items \
     --header 'accept: application/json' \
     --header 'x-api-key: <your api key>'
```

--------------------------------

### GET /nx/items

Source: https://docs.gameshift.dev/docs/stackable-assets

Retrieves a paginated list of all Stackable Assets (SFTs) within your GameShift project. You can filter by type and sale status.

```APIDOC
## GET /nx/items

### Description
Retrieves a paginated list of all Stackable Assets (SFTs) within your GameShift project. You can filter by type and sale status.

### Method
GET

### Endpoint
https://api.gameshift.dev/nx/items

### Parameters
#### Query Parameters
- **types** (string) - Optional - Filter by item type (e.g., "StackableAsset").
- **forSale** (boolean) - Optional - Filter items that are for sale (true) or not (false).

### Request Example
```curl
curl -X 'GET' \
  'https://api.gameshift.dev/nx/items?types=StackableAsset&forSale=false' \
  -H 'accept: application/json' \
  -H 'x-api-key: <api_key>'
```

### Response
#### Success Response (200)
- **data** (array) - An array of objects, where each object contains the `type` and `item` details of a Stackable Asset.
- **meta** (object) - Pagination metadata including `page`, `perPage`, `totalPages`, and `totalResults`.

#### Response Example
```json
{
  "data": [
    {
      "type": "StackableAsset",
      "item": {
        "id": "c1b6d69b-4cb3-4d88-8369-0a5329adac7e",
        "collection": {
          "id": "3cdf417c-fcc7-4fa1-9257-47abd95fc34a",
          "name": "collection",
          "description": "desc",
          "environment": "Development",
          "imageUrl": "https://crossmint.myfilebase.com/ipfs/QmcuF9AetzMMFX1h2eGh6u9ZmtP3wXuggzKuFpeg4geUi9",
          "imported": false,
          "mintAddress": "",
          "created": 1720659969799
        },
        "attributes": [
          {
            "value": "string",
            "traitType": "string"
          }
        ],
        "created": 1721401752333,
        "name": "Boots",
        "symbol": "BOOT",
        "description": "string",
        "environment": "Development",
        "imageUrl": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS1LkL-UpJ4ZHWeaAEEVhobaxvUNyPYxsgofQ&s",
        "status": "Committed",
        "mintAddress": ""
      }
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1,
    "totalResults": 1
  }
}
```
```

--------------------------------

### Imported Currency Details

Source: https://docs.gameshift.dev/docs/working-with-game-assets

Example JSON response after successfully importing a currency into GameShift. It includes the assigned ID, the original mint address, and any detected name and symbol.

```json
{
  "id": "0a6fdc5c-5bef-4736-97ee-977d1ba952ab",
  "mintAddress": "Bb9bsTQa1bGEtQ5KagGkvSHyuLqDWumGUcRqFusFNJWC",
  "name": "Example Currency",
  "symbol": "EXMP"
}
```

--------------------------------

### List SKUs with Filters (JavaScript)

Source: https://docs.gameshift.dev/docs/storefront-api

Shows how to use the `listSkus` method from the Storefront SDK to retrieve a list of available SKUs. It accepts various filtering parameters like price range, name, and asset type. The example filters by price and name.

```javascript
// listSkus parameters
// page?: number;
// perPage?: number;
// priceLessThan?: string;
// priceGreaterThan?: string;
// nameContains?: string;
// type?: 'NewMintUniqueAsset' | 'OffChainAsset';
// collectionId?: string;

// Example usage
storefront.listSkus({
  priceLessThan: "5",
  nameContains: "MyAsset"
}).then((results) => {
  console.log(results);
});

// Sample Response
// {
//   data: [{
//   assetInventoryId: "713c0942-b43b-4686-96bb-1b31e515ed81",
//   created: "2024-11-11T01:42:55.530Z",
//   id: "57bf4030-5987-4fad-a0ee-61636eeaab09",
//   inventory: {
//     created: "2024-11-10T00:03:14.803Z",
//     currentQuantity: 0,
//     id: "713c0942-b43b-4686-96bb-1b31e515ed81",
//     imageUrl: "https://example.com/image.jpg",
//     maxQuantity: 1,
//     name: "string",
//     updated: "2024-11-13T00:03:14.803Z",
//     vendorData: null
//   },
//   name: "MyAsset",
//   price: {
//     currencyId: "USDC",
//     naturalAmount: "1.2"
//   },
//   type: "OffChainAsset",
//   updated: "2024-11-13T01:42:55.530Z",
//   vendorData: null
// }],
//     page: 1,
//     perPage: 10,
//     total: 1
//   },
// }
```

--------------------------------

### GET /nx/users/{userId}/items - Fetch User's Owned Items

Source: https://docs.gameshift.dev/docs/gameshift-interaction

Retrieves a paginated list of items owned by a specific user, including currencies and unique assets. Filters can be applied to refine the results.

```APIDOC
## GET /nx/users/{userId}/items

### Description
Fetch a user's owned items, including Currencies and Unique Assets. This endpoint supports pagination and filtering by item type, sale status, or collection.

### Method
GET

### Endpoint
https://api.gameshift.dev/nx/users/{userId}/items

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the user whose items are being fetched (typically the `referenceId` used during onboarding).

#### Query Parameters
- **type** (string) - Optional - Filters items by type (e.g., 'Currency', 'UniqueAsset').
- **forSale** (boolean) - Optional - Filters items to include only those listed for sale on the marketplace.
- **collectionId** (string) - Optional - Filters items to include only those belonging to a specific collection.
- **page** (integer) - Optional - The page number for paginated results. Defaults to 1.
- **perPage** (integer) - Optional - The number of items per page. Defaults to 50.

### Request Example
```bash
curl --request GET \
     --url https://api.gameshift.dev/nx/users/exampleReferenceId/items \
     --header 'accept: application/json' \
     --header 'x-api-key: <your api key>'
```

### Response
#### Success Response (200)
- **data** (array) - A paginated list of the user's owned items.
  - **type** (string) - The type of the item (e.g., 'Currency', 'UniqueAsset').
  - **item** (object) - Details of the item.
    - **id** (string) - Unique identifier for the item.
    - **mintAddress** (string) - The mint address of the item on the blockchain.
    - **name** (string) - The name of the item.
    - **symbol** (string) - The symbol of the item (if applicable).
    - **attributes** (array) - For UniqueAssets, an array of trait objects.
    - **collection** (object) - For UniqueAssets, details about the collection the item belongs to.
    - **quantity** (string) - The quantity of the item owned (for Currencies).
- **meta** (object) - Metadata for pagination.
  - **page** (integer) - The current page number.
  - **perPage** (integer) - The number of items per page.
  - **totalPages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "data": [
    {
      "type": "Currency",
      "item": {
        "id": "string",
        "mintAddress": "string",
        "name": "string",
        "symbol": "string"
      },
      "quantity": "1254"
    },
    {
      "type": "UniqueAsset",
      "item": {
        "id": "string",
        "attributes": [
          {
            "traitType": "string",
            "value": "string"
          }
        ],
        "created": 0,
        "name": "string",
        "collection": {
          "id": "string",
          "name": "string",
          "description": "string",
          "environment": {},
          "imageUrl": "string",
          "imported": true,
          "mintAddress": "string",
          "created": 0,
          "stats": {
            "numMinted": 0,
            "floorPrice": 0,
            "numListed": 0,
            "numOwners": 0
          }
        },
        "description": "string",
        "environment": {},
        "imported": true,
        "imageUrl": "string",
        "status": "Unprocessed",
        "forSale": true,
        "mintAddress": "string",
        "owner": {
          "address": "string",
          "referenceId": "string"
        },
        "price": {
          "currencyId": "USDC",
          "naturalAmount": "0"
        }
      }
    }
   ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1
  }
}
```
```

--------------------------------

### Recipe Creation API Response (JSON)

Source: https://docs.gameshift.dev/docs/crafting

This is an example of the JSON response received after successfully creating a crafting recipe. It includes a unique `recipeId` to identify the recipe and a `consentUrl` that users must navigate to provide consent for the recipe's consumption.

```json
{
  "recipeId": "c0e2f267-d336-45bd-b3b9-a0a4dc33e81f",
  "consentUrl": "https://app.gameshift.dev/consent?id=ea307b18-af43-45a9-9e2b-c213f4ba4864"
}
```

--------------------------------

### POST /nx/users - Onboard Your Users

Source: https://docs.gameshift.dev/docs/gameshift-interaction

Registers new users on GameShift, provisioning them a wallet. Requires a valid email address and a unique referenceId.

```APIDOC
## POST /nx/users

### Description
Onboard your users onto GameShift and provision them a wallet. This endpoint registers users, granting them access to marketplace features, chain assets, and interactions with GameShift’s payment flows. A valid email address is required for the user.

### Method
POST

### Endpoint
https://api.gameshift.dev/nx/users

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **referenceId** (string) - Required - A unique identifier for the user, compatible with your authentication system (e.g., UUID). Cannot contain spaces or slashes.
- **email** (string) - Required - The user's email address. Must be unique and should be verified before registration as it's used for transaction approvals.
- **externalWalletAddress** (string) - Optional - If provided, registers the user with a non-GameShift wallet address.

### Request Example
```json
{
  "referenceId": "exampleReferenceId",
  "email": "user@example.com"
}
```

### Response
#### Success Response (200)
- **referenceId** (string) - The reference ID provided in the request.
- **email** (string) - The email address provided in the request.

#### Response Example
```json
{
  "referenceId": "exampleReferenceId",
  "email": "user@example.com"
}
```
```

--------------------------------

### Initiate Withdrawal Request (JSON Example)

Source: https://docs.gameshift.dev/docs/withdrawals-copy

Example JSON response when initiating a withdrawal request. It contains a consent URL that the user must visit to complete the transaction and a unique transaction ID.

```json
{
  "consentUrl": "https://app.gameshift.dev/withdraw?id=l1zc069a-cd74-4e49-bdx6-2da324d17952",
  "transactionId": "l1zc069a-cd74-4e49-bdx6-2da324d17952"
}
```

--------------------------------

### GET /nx/items?forSale=true

Source: https://docs.gameshift.dev/docs/marketplace

Retrieves a list of all unique assets currently listed for sale on the marketplace. This endpoint utilizes query parameter filters on the 'Get Many Items' endpoint.

```APIDOC
## GET /nx/items?forSale=true

### Description
Retrieves a list of all assets currently listed on the marketplace.

### Method
GET

### Endpoint
`https://api.gameshift.dev/nx/items?forSale=true`

### Parameters
#### Query Parameters
- **forSale** (boolean) - Optional - Filter to only show items that are currently for sale. Defaults to false.

### Response
#### Success Response (200)
- **data** (array) - An array of unique asset objects.
  - **type** (string) - The type of the asset (e.g., "UniqueAsset").
  - **item** (object) - Details of the unique asset.
    - **id** (string) - The unique identifier of the item.
    - **collection** (object) - Information about the collection the item belongs to.
    - **created** (number) - Timestamp of when the item was created.
    - **attributes** (array) - An array of attributes for the item.
    - **name** (string) - The name of the item.
    - **description** (string) - The description of the item.
    - **environment** (string) - The environment the item is in (e.g., "Development").
    - **forSale** (boolean) - Indicates if the item is for sale.
    - **imageUrl** (string) - URL of the item's image.
    - **imported** (boolean) - Indicates if the item was imported.
    - **price** (object) - Pricing information for the item.
    - **status** (string) - The status of the item (e.g., "Committed").
    - **mintAddress** (string) - The mint address of the item.
    - **owner** (object) - Information about the owner of the item.
- **meta** (object) - Metadata about the pagination of the results.

#### Response Example
```json
{
  "data": [
    {
      "type": "UniqueAsset",
      "item": {
        "id": "5036c3f0-16f5-4212-9601-773b348558b7",
        "collection": {
          "id": "76ce1359-2124-40f1-b011-a97316ac9e03",
          "name": "Example Collection",
          "description": "This is an example",
          "environment": "Development",
          "imageUrl": "https://cloudflare-ipfs.com/ipfs/QmWsnbRQV8vYCSkrVU8uvgQeSnkiD9MLZv2kmuKDUXh2VC",
          "imported": false,
          "mintAddress": "AUFD3zYELr4BJh1A7vqsVtuGELRQxeJVNG55zyizDynS",
          "created": 1701965780057
        },
        "created": 1707935037900,
        "attributes": [
          {
            "value": "Example Value",
            "traitType": "example-trait"
          }
        ],
        "name": "Example Asset",
        "description": "This is an example asset",
        "environment": "Development",
        "forSale": true,
        "imageUrl": "https://solana.com/src/img/branding/solanaLogoMark.png",
        "imported": false,
        "price": {
          "currencyId": "USDC",
          "naturalAmount": "2000"
        },
        "status": "Committed",
        "mintAddress": "H9qXqvCetS3wJ7x7n8ynfWG9cEQjyCQyWEA1kCLyaXhs",
        "owner": {
          "address": "qYpoPgN3NnTKN5zdCzcbyaQYpyp13cHyQdKke8fHMep",
          "referenceId": "exampleUserId"
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1,
    "totalResults": 1
  }
}
```
```

--------------------------------

### GET /nx/crafting-recipes/{id-of-the-recipe}

Source: https://docs.gameshift.dev/docs/crafting

Polls for the latest fulfillment status of a crafting recipe by making a GET http request to the specified endpoint. The response includes details about the recipe and its current status.

```APIDOC
## GET /nx/crafting-recipes/{id-of-the-recipe}

### Description
Polls for the latest fulfillment status of a crafting recipe.

### Method
GET

### Endpoint
`https://api.gameshift.dev/nx/crafting-recipes/{id-of-the-recipe}`

### Parameters
#### Path Parameters
- **id-of-the-recipe** (string) - Required - The unique identifier of the crafting recipe.

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl --request GET \
     --url https://api.gameshift.dev/nx/crafting-recipes/c0e2f267-d336-45bd-b3b9-a0a4dc33e81f \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: <your key here>'
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the recipe.
- **metadata** (object) - Contains metadata about the recipe.
  - **title** (string) - The title of the recipe.
  - **description** (string) - A description of the recipe.
  - **image** (string) - A URL to an image representing the recipe.
- **craftingUserReferenceId** (string) - A reference ID for the user performing the crafting.
- **consumes** (array) - A list of items or currency consumed by the recipe.
  - **type** (string) - The type of item being consumed (e.g., 'Currency', 'UniqueAsset', 'StackableAsset').
  - **id** (string) - The unique identifier of the consumed item or currency.
  - **naturalAmount** (string) - The natural amount of the consumed item or currency (if applicable).
- **status** (string) - The current status of the recipe (e.g., "Pending", "Failed", "Confirmed", "Expired").
- **transactions** (array) - A list of transactions associated with the recipe.
  - **id** (string) - The unique identifier of the transaction.
  - **created** (string) - The date the transaction was created.
  - **status** (object) - The status of the transaction.
    - **status** (string) - The status of the transaction (e.g., "Confirmed", "Pending").
    - **txHash** (string) - The transaction hash (if confirmed).

#### Response Example
```json
{
  "id":  "c0e2f267-d336-45bd-b3b9-a0a4dc33e81f",
  "metadata": {
    "title": "Craft +2 Sword",
    "description": "Craft a more powerful sword",
    "image": "https://example.image.png"
  },
  "craftingUserReferenceId": "exampleReferenceId",
  "consumes": [
    {
      "type": "Currency",
      "id": "81016eb1-ec78-4ca8-a304-44866ca30304",
      "naturalAmount": "1000"
    },
    {
      "type": "UniqueAsset",
      "id": "7bc5c81c-c024-4e73-b385-34516c5db510"
    },
    {
      "type": "UniqueAsset",
      "id": "4b969959-3ad1-4354-bb22-5990e1d6678e"
    },
    {
      "type": "StackableAsset",
      "id": "c377fee4-9e19-4aed-a9a0-f333f3cf7457",
      "naturalAmount": "1000"
    }
  ],
  "status": "Pending",
  "transactions": [
    {
    	"id": "ea307b18-af43-45a9-9e2b-c213f4ba4864",
      "created": "2024-05-12",
      "status": {
        "status": "Confirmed",
        "txHash": "5fJVtHGk2t5HzqBVGjc3qvkHkzyokA3k9eH4VwUnKK1jMm7MLeqW5r8nC719ABoq3wLQEkZaHsFJ3ovJZtec9xEA"
      }
    },
    {
      "id": "ca684e4c-695c-4ed9-98ae-20715047b47b",
      "created": "2024-05-12",
      "status": {
        "status": "Pending"
      }
    }
  ]
}
```
```

--------------------------------

### Initialize Gameshift Storefront SDK (JavaScript)

Source: https://docs.gameshift.dev/docs/storefront-api

Demonstrates how to initialize the Gameshift Storefront SDK in a JavaScript project. Requires an API key and an environment setting. The SDK can be included via script tag or npm.

```html
<script src="https://api.gameshift.dev/nx/storefront/sdk?v=1.0"></script>
```

```javascript
const storefront = new Storefront({
            apiKey: 'STOREFRONT_API_KEY',
            environment: "Development"
        });
```

--------------------------------

### Storefront SDK - Initialization

Source: https://docs.gameshift.dev/docs/storefront-api

Demonstrates how to initialize the Gameshift Storefront JS SDK in your project.

```APIDOC
## Storefront SDK Initialization

### Description
Initializes the Gameshift Storefront JavaScript SDK to interact with the Storefront API.

### Method
JavaScript

### Endpoint
`https://api.gameshift.dev/nx/storefront/sdk` (via script import)

### Usage
**1. Script Import:**
```html
<script src="https://api.gameshift.dev/nx/storefront/sdk?v=1.0"></script>
```

**2. Initialization:**
```javascript
const storefront = new Storefront({
    apiKey: 'YOUR_STOREFRONT_API_KEY',
    environment: "Development" // or "Production"
});
```

### Parameters
- **apiKey** (string) - Required - Your unique Storefront API key.
- **environment** (string) - Required - The environment to connect to (`Development` or `Production`).
```

--------------------------------

### Get Tournament Statistics

Source: https://docs.gameshift.dev/docs/perpetual-tournaments-1

Retrieves various statistics and details about perpetual tournaments.

```APIDOC
## GET /nx/tournaments/perpetual

### Description
Returns a list of all perpetual tournaments or top-level details for a specific tournament.

### Method
GET

### Endpoint
/nx/tournaments/perpetual

### Parameters
#### Query Parameters
- **id** (string) - Optional - The ID of the tournament to retrieve details for.

### Response
#### Success Response (200)
- **tournaments** (array) - List of tournament objects if no ID is provided.
- **details** (object) - Tournament details if ID is provided.
  - **prizePool** (number) - The prize pool amount.
  - **commissionRecipient** (string) - The commission recipient address.
  - **status** (string) - The current status of the tournament.

#### Response Example (List)
```json
{
  "tournaments": [
    { "id": "tournament-123", "status": "Run Tournament" },
    { "id": "tournament-456", "status": "Creation" }
  ]
}
```

#### Response Example (Details)
```json
{
  "details": {
    "prizePool": 10000,
    "commissionRecipient": "0x123...",
    "status": "Run Tournament"
  }
}
```

## GET /nx/tournaments/perpetual/{id}/enrolledUsers

### Description
Returns the list of players enrolled in a tournament and their current standings.

### Method
GET

### Endpoint
/nx/tournaments/perpetual/{id}/enrolledUsers

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tournament.

### Response
#### Success Response (200)
- **enrolledUsers** (array) - List of enrolled users with their standings.
  - **userId** (string) - The player's ID.
  - **standings** (number) - The player's current standings.

#### Response Example
```json
{
  "enrolledUsers": [
    { "userId": "player-abc", "standings": 100 },
    { "userId": "player-def", "standings": 90 }
  ]
}
```

## GET /nx/tournaments/perpetual/{id}/commissions

### Description
Reports current commission balances and historical disbursements for a tournament.

### Method
GET

### Endpoint
/nx/tournaments/perpetual/{id}/commissions

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tournament.

### Response
#### Success Response (200)
- **commissionBalance** (number) - The current commission balance.
- **historicalDisbursements** (array) - List of historical commission disbursements.

#### Response Example
```json
{
  "commissionBalance": 500,
  "historicalDisbursements": [
    { "amount": 100, "timestamp": "2023-10-27T10:00:00Z" },
    { "amount": 50, "timestamp": "2023-10-26T10:00:00Z" }
  ]
}
```
```

--------------------------------

### Retrieve Items for Sale from Marketplace API

Source: https://docs.gameshift.dev/docs/marketplace

Fetches a list of all unique assets currently listed for sale on the GameShift marketplace. This is achieved by making a GET request to the 'Get Many Items' endpoint with the 'forSale' query parameter set to true. The response includes detailed information about each item, such as its ID, collection details, price, and owner.

```curl
curl --request GET \
     --url https://api.gameshift.dev/nx/items?forSale=true \
     --header 'accept: application/json' \
     --header 'x-api-key: <your api key>'
```

--------------------------------

### GET /nx/developer-wallet

Source: https://docs.gameshift.dev/docs/developer-wallets

Retrieves the unique developer wallet address associated with your project.

```APIDOC
## GET /nx/developer-wallet

### Description
Retrieves the unique developer wallet address for your project. This requires a generated wallet key.

### Method
GET

### Endpoint
https://api.gameshift.dev/nx/developer-wallet

### Parameters
#### Headers
- **x-api-key** (string) - Required - Your GameShift API key.
- **accept** (string) - Optional - Defaults to `application/json`.
- **content-type** (string) - Optional - Defaults to `application/json`.

### Response
#### Success Response (200)
- **walletAddress** (string) - The unique address of the developer wallet.

#### Response Example
```json
{
  "walletAddress": "De6z1482rsTpD2Zh8Lqot12MnFMz16U8CgDdPGhMiGEA"
}
```
```

--------------------------------

### Create NewMintUniqueAsset

Source: https://docs.gameshift.dev/docs/storefront-api

Creates a `NewMintUniqueAsset` that allows a new asset to be minted as a cNFT to the buyer upon purchase.

```APIDOC
## POST /nx/storefront/inventory/NewMintUniqueAsset

### Description
Creates a `NewMintUniqueAsset` which mints a new cNFT to the buyer upon purchase.

### Method
POST

### Endpoint
`/nx/storefront/inventory/NewMintUniqueAsset`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the asset.
- **imageUrl** (string) - Required - The URL of the asset's image.
- **attributes** (Array<{traitType: string, value: string}>) - Optional - On-chain attributes for the cNFT.
- **maxQuantity** (number) - Optional - The maximum quantity of this asset available.
- **collectionId** (string) - Required - The Gameshift collection UUID.
- **vendorData** (Record<string, any>) - Optional - Additional vendor-specific data.

### Request Example
```json
{
  "name": "Example Mintable Asset",
  "imageUrl": "https://example.com/mintable.jpg",
  "attributes": [
    {"traitType": "Rarity", "value": "Epic"}
  ],
  "maxQuantity": 10,
  "collectionId": "your-collection-uuid",
  "vendorData": {
    "externalLink": "http://example.com/asset/123"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created NewMintUniqueAsset.
- **name** (string) - The name of the asset.
- **imageUrl** (string) - The URL of the asset's image.
- **attributes** (Array<{traitType: string, value: string}>) - On-chain attributes.
- **maxQuantity** (number) - The maximum quantity of this asset.
- **collectionId** (string) - The associated collection UUID.
- **vendorData** (Record<string, any>) - Vendor data associated with the asset.

#### Response Example
```json
{
  "id": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
  "name": "Example Mintable Asset",
  "imageUrl": "https://example.com/mintable.jpg",
  "attributes": [
    {"traitType": "Rarity", "value": "Epic"}
  ],
  "maxQuantity": 10,
  "collectionId": "your-collection-uuid",
  "vendorData": {
    "externalLink": "http://example.com/asset/123"
  }
}
```
```

--------------------------------

### Fetch User Items API

Source: https://docs.gameshift.dev/docs/onboard-your-users

Retrieve a paginated list of a user's owned items, including currencies and unique assets. Filters can be applied to narrow down the results.

```APIDOC
## GET /nx/users/{userId}/items

### Description
Fetches a paginated list of items owned by a specific user. Supports filtering by item type, sale status, and collection.

### Method
GET

### Endpoint
`https://api.gameshift.dev/nx/users/{userId}/items`

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier (referenceId) of the user whose items are to be fetched.

#### Query Parameters
- **type** (string) - Optional - Filters items by type (e.g., "Currency", "UniqueAsset").
- **forSale** (boolean) - Optional - Filters items to only include those listed for sale on the marketplace.
- **collectionId** (string) - Optional - Filters items to only include those belonging to a specific collection.

### Response
#### Success Response (200)
A paginated list of the user's owned items.
- **data** (array) - An array of item objects.
  - **type** (string) - The type of the item (e.g., "Currency", "UniqueAsset").
  - **item** (object) - Details of the item.
    - **id** (string) - Unique identifier for the item.
    - **mintAddress** (string) - The mint address of the item on the blockchain.
    - **name** (string) - The name of the item.
    - **symbol** (string) - The symbol of the item (for currencies).
    - **attributes** (array) - List of attributes for Unique Assets.
    - **collection** (object) - Details about the item's collection.
    - **description** (string) - Description of the item.
    - **imageUrl** (string) - URL of the item's image.
    - **status** (string) - Status of the item (e.g., "Unprocessed").
    - **forSale** (boolean) - Indicates if the item is for sale.
    - **owner** (object) - Information about the item's owner.
    - **price** (object) - Pricing information if the item is for sale.
- **meta** (object) - Pagination metadata.
  - **page** (integer) - Current page number.
  - **perPage** (integer) - Number of items per page.
  - **totalPages** (integer) - Total number of pages.

#### Response Example
```json
{
  "data": [
    {
      "type": "Currency",
      "item": {
        "id": "string",
        "mintAddress": "string",
        "name": "string",
        "symbol": "string"
      },
      "quantity": "1254"
    },
    {
      "type": "UniqueAsset",
      "item": {
        "id": "string",
        "attributes": [
          {
            "traitType": "string",
            "value": "string"
          }
        ],
        "created": 0,
        "name": "string",
        "collection": {
          "id": "string",
          "name": "string",
          "description": "string",
          "environment": {},
          "imageUrl": "string",
          "imported": true,
          "mintAddress": "string",
          "created": 0,
          "stats": {
            "numMinted": 0,
            "floorPrice": 0,
            "numListed": 0,
            "numOwners": 0
          }
        },
        "description": "string",
        "environment": {},
        "imported": true,
        "imageUrl": "string",
        "status": "Unprocessed",
        "forSale": true,
        "mintAddress": "string",
        "owner": {
          "address": "string",
          "referenceId": "string"
        },
        "price": {
          "currencyId": "USDC",
          "naturalAmount": "0"
        }
      }
    }
   ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "totalPages": 1
  }
}
```
```

--------------------------------

### Get Unique Asset Status via API (json)

Source: https://docs.gameshift.dev/docs/working-with-game-assets

This snippet illustrates the JSON response when polling for the status of a unique asset that has been committed to the blockchain. It provides updated details including the owner's wallet address and reference ID, indicating successful on-chain creation. This response is obtained by making a GET request to `https://api.gameshift.dev/nx/items/{the-id-of-the-asset}`.

```json
{
  "type": "UniqueAsset",
  "item": {
    "id": "dcde5bc8-b30b-46b6-b4da-0763953b2484",
    "collection": {
      "id": "36c97125-04a5-4dc3-b92a-029d74a42287",
      "name": "Example Collection",
      "description": "Example collection description",
      "environment": "Development",
      "imageUrl": "https://solana.com/src/img/branding/solanaLogoMark.png",
      "imported": false,
      "mintAddress": "9TLcFuCyWeHR3tySiMr7PjGmeUHhpFDiaJ4ykUQ2RyDu",
      "created": "1709219450063"
    },
    "created": 1710169624330,
    "attributes": [
      {
        "traitType": "attribute-name",
        "value": "attribute-value"
      }
    ],
    "name": "Example Asset",
    "description": "Example description",
    "environment": "Development",
    "forSale": false,
    "imageUrl": "https://solana.com/src/img/branding/solanaLogoMark.png",
    "imported": false,
    "price": null,
    "status": "Committed",
    "mintAddress": "DP7geA17WLnb2XQ9w2nRNkbwDeJA6kQxGheN7N1iYzPs",
    "owner": {
      "address": "BuHuaXF6N5w6gtkApJ4ubM7ytuAxq7h5HYQPDk4MWVuy",
      "referenceId": "exampleUserId"
    }
  }
}
```

--------------------------------

### GET /nx/developer-wallet/items

Source: https://docs.gameshift.dev/docs/developer-wallets

Fetches the balances of currencies and unique assets within your developer wallet.

```APIDOC
## GET /nx/developer-wallet/items

### Description
Fetches the current balances of all currencies and unique assets held within your developer wallet.

### Method
GET

### Endpoint
https://api.gameshift.dev/nx/developer-wallet/items

### Parameters
#### Headers
- **x-api-key** (string) - Required - Your GameShift API key.
- **accept** (string) - Optional - Defaults to `application/json`.

### Response
#### Success Response (200)
- **items** (object) - Contains a list of items and their quantities.
  - **data** (array) - An array of item objects.
    - **type** (string) - The type of item (e.g., "Currency").
    - **item** (object) - Details about the item.
      - **id** (string) - The item's unique identifier.
      - **mintAddress** (string) - The blockchain mint address for the item.
      - **name** (string) - The name of the item.
      - **symbol** (string) - The symbol of the item.
    - **quantity** (string) - The quantity of the item in the wallet.
  - **meta** (object) - Pagination metadata.
    - **page** (integer) - The current page number.
    - **perPage** (integer) - The number of items per page.
    - **totalPages** (integer) - The total number of pages available.

#### Response Example
```json
{
  "items": {
    "data": [
      {
        "type": "Currency",
        "item": {
          "id": "SOL",
          "mintAddress": "11111111111111111111111111111111",
          "name": "SOL",
          "symbol": "SOL"
        },
        "quantity": "0"
      },
      {
        "type": "Currency",
        "item": {
          "id": "USDC",
          "mintAddress": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
          "name": "USD Coin",
          "symbol": "USDC"
        },
        "quantity": "0"
      }
    ],
    "meta": {
      "page": 1,
      "perPage": 50,
      "totalPages": 1
    }
  }
}
```
```

--------------------------------

### User Registration API

Source: https://docs.gameshift.dev/docs/onboard-your-users

Register new users to GameShift to grant them access to marketplace features, chain assets, and interactions with GameShift’s payment flows. A unique `referenceId` and a valid user email address are required.

```APIDOC
## POST /nx/users

### Description
Registers a new user on GameShift, provisioning them with a wallet. Requires a unique `referenceId` and the user's email address.

### Method
POST

### Endpoint
`https://api.gameshift.dev/nx/users`

### Parameters
#### Request Body
- **referenceId** (string) - Required - A unique identifier for the user, compatible with your authentication system (e.g., UUID). Cannot contain spaces or slashes.
- **email** (string) - Required - The user's email address. Must be unique and used for transaction approvals.
- **externalWalletAddress** (string) - Optional - The address of a non-GameShift wallet if you wish to link one.

### Request Example
```json
{
  "referenceId": "exampleReferenceId",
  "email": "user@example.com"
}
```

### Response
#### Success Response (200)
Returns the details provided in the request, including the user's on-chain wallet address.
- **referenceId** (string) - The unique reference ID of the user.
- **email** (string) - The email address of the user.

#### Response Example
```json
{
  "referenceId": "exampleReferenceId",
  "email": "user@example.com"
}
```
```
Tokens:
Raw