# SdPublicProdApi.TokenEndpointsApi

All URIs are relative to *https://core-api.stardust.gg/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**tokenBlockchainStatusGetGet**](TokenEndpointsApi.md#tokenBlockchainStatusGetGet) | **GET** /token/blockchain-status-get | Get Token Status
[**tokenBurnPost**](TokenEndpointsApi.md#tokenBurnPost) | **POST** /token/burn | Burn Token
[**tokenCreatePost**](TokenEndpointsApi.md#tokenCreatePost) | **POST** /token/create | Create Token
[**tokenGetAllGet**](TokenEndpointsApi.md#tokenGetAllGet) | **GET** /token/get-all | Get All Tokens
[**tokenGetGet**](TokenEndpointsApi.md#tokenGetGet) | **GET** /token/get | Get Token
[**tokenMintBulkPost**](TokenEndpointsApi.md#tokenMintBulkPost) | **POST** /token/mint-bulk | Mint Tokens
[**tokenMintGetAllGet**](TokenEndpointsApi.md#tokenMintGetAllGet) | **GET** /token/mint/get-all | Get All Token Mints
[**tokenMintPost**](TokenEndpointsApi.md#tokenMintPost) | **POST** /token/mint | Mint Token
[**tokenMutatePut**](TokenEndpointsApi.md#tokenMutatePut) | **PUT** /token/mutate | Mutate Token
[**tokenPropsRemoveDelete**](TokenEndpointsApi.md#tokenPropsRemoveDelete) | **DELETE** /token/props-remove | Remove Token Property
[**tokenRemoveDelete**](TokenEndpointsApi.md#tokenRemoveDelete) | **DELETE** /token/remove | Remove Token
[**tokenTransferPost**](TokenEndpointsApi.md#tokenTransferPost) | **POST** /token/transfer | Transfer Tokens

<a name="tokenBlockchainStatusGetGet"></a>
# **tokenBlockchainStatusGetGet**
> SDTokenBlockchainStatusGetResponses tokenBlockchainStatusGetGet(tokenIds)

Get Token Status

Gets the Status of the Transaction of the Token(s) on the Blockchain

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let tokenIds = "tokenIds_example"; // String | Comma-Separated String of token ids (ex. '3589, 3580')

apiInstance.tokenBlockchainStatusGetGet(tokenIds, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenIds** | **String**| Comma-Separated String of token ids (ex. &#x27;3589, 3580&#x27;) | 

### Return type

[**SDTokenBlockchainStatusGetResponses**](SDTokenBlockchainStatusGetResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenBurnPost"></a>
# **tokenBurnPost**
> Empty tokenBurnPost(body)

Burn Token

The Opposite of theon/mint, this Removes Token(s) from a Player

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenBurnRequest(); // SDTokenBurnRequest | 

apiInstance.tokenBurnPost(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenBurnRequest**](SDTokenBurnRequest.md)|  | 

### Return type

[**Empty**](Empty.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="tokenCreatePost"></a>
# **tokenCreatePost**
> SDTokenCreateResponse tokenCreatePost(body)

Create Token

Adds a New Token

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenCreateRequest(); // SDTokenCreateRequest | 

apiInstance.tokenCreatePost(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenCreateRequest**](SDTokenCreateRequest.md)|  | 

### Return type

[**SDTokenCreateResponse**](SDTokenCreateResponse.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="tokenGetAllGet"></a>
# **tokenGetAllGet**
> SDTokenGetAllResponses tokenGetAllGet(templateId, opts)

Get All Tokens

This Returns a List of Every Single Token ever Minted in Your Game, Expect Quite a Big Paginated Response

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let templateId = "templateId_example"; // String | The ID of the Template
let opts = { 
  'start': "start_example", // String | position in list
  'limit': "limit_example" // String | maximum templates returned in list
};
apiInstance.tokenGetAllGet(templateId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **templateId** | **String**| The ID of the Template | 
 **start** | **String**| position in list | [optional] 
 **limit** | **String**| maximum templates returned in list | [optional] 

### Return type

[**SDTokenGetAllResponses**](SDTokenGetAllResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenGetGet"></a>
# **tokenGetGet**
> SDTokenGetResponses tokenGetGet(tokenIds)

Get Token

Some of the details of this token are based upon the Template that it was created from (using token/mint)

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let tokenIds = "tokenIds_example"; // String | Stringify Array of token ids (ex. '[3589, 3580]')

apiInstance.tokenGetGet(tokenIds, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenIds** | **String**| Stringify Array of token ids (ex. &#x27;[3589, 3580]&#x27;) | 

### Return type

[**SDTokenGetResponses**](SDTokenGetResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenMintBulkPost"></a>
# **tokenMintBulkPost**
> SDTokenMintBulkResponses tokenMintBulkPost(body)

Mint Tokens

Give a Specific Amount of Multiple Tokens to a Player, this is the Opposite of token/burn

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenMintBulkRequest(); // SDTokenMintBulkRequest | 

apiInstance.tokenMintBulkPost(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenMintBulkRequest**](SDTokenMintBulkRequest.md)|  | 

### Return type

[**SDTokenMintBulkResponses**](SDTokenMintBulkResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="tokenMintGetAllGet"></a>
# **tokenMintGetAllGet**
> SDTokenMintGetAllResponses tokenMintGetAllGet(opts)

Get All Token Mints

Returns a List of Players/Owners with the Amount of Tokens Minted to them

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let opts = { 
  'tokenId': "tokenId_example", // String | The ID of the token minted
  'start': "start_example", // String | position in list
  'templateId': "templateId_example", // String | The ID of the Template
  'limit': "limit_example" // String | maximum templates returned in list
};
apiInstance.tokenMintGetAllGet(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenId** | **String**| The ID of the token minted | [optional] 
 **start** | **String**| position in list | [optional] 
 **templateId** | **String**| The ID of the Template | [optional] 
 **limit** | **String**| maximum templates returned in list | [optional] 

### Return type

[**SDTokenMintGetAllResponses**](SDTokenMintGetAllResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenMintPost"></a>
# **tokenMintPost**
> SDTokenMintResponses tokenMintPost(body)

Mint Token

Give a Specific Amount of a Token to a Player, this is the Opposite of token/burn

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenMintRequest(); // SDTokenMintRequest | 

apiInstance.tokenMintPost(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenMintRequest**](SDTokenMintRequest.md)|  | 

### Return type

[**SDTokenMintResponses**](SDTokenMintResponses.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="tokenMutatePut"></a>
# **tokenMutatePut**
> Empty tokenMutatePut(body)

Mutate Token

Mutates a Property of a Token

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenMutateRequest(); // SDTokenMutateRequest | 

apiInstance.tokenMutatePut(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenMutateRequest**](SDTokenMutateRequest.md)|  | 

### Return type

[**Empty**](Empty.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="tokenPropsRemoveDelete"></a>
# **tokenPropsRemoveDelete**
> Empty tokenPropsRemoveDelete(tokenId, props)

Remove Token Property

Removes a Tokens Property from Your Game

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let tokenId = "tokenId_example"; // String | Token Id returned from token/create (ex. 5)
let props = "props_example"; // String | Stringify Array of token mutable property names ex: '[\"exp\", \"health\"]' }

apiInstance.tokenPropsRemoveDelete(tokenId, props, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenId** | **String**| Token Id returned from token/create (ex. 5) | 
 **props** | **String**| Stringify Array of token mutable property names ex: &#x27;[\&quot;exp\&quot;, \&quot;health\&quot;]&#x27; } | 

### Return type

[**Empty**](Empty.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenRemoveDelete"></a>
# **tokenRemoveDelete**
> Empty tokenRemoveDelete(tokenId)

Remove Token

Removes a Token

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let tokenId = "tokenId_example"; // String | Token Id unsigned 32 bit integer

apiInstance.tokenRemoveDelete(tokenId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenId** | **String**| Token Id unsigned 32 bit integer | 

### Return type

[**Empty**](Empty.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="tokenTransferPost"></a>
# **tokenTransferPost**
> Empty tokenTransferPost(body)

Transfer Tokens

Use this Endpoint to Facilitate Moving Tokens from one Player to Another

### Example
```javascript
import {SdPublicProdApi} from 'sd_public_prod_api';
let defaultClient = SdPublicProdApi.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SdPublicProdApi.TokenEndpointsApi();
let body = new SdPublicProdApi.SDTokenTransferRequest(); // SDTokenTransferRequest | 

apiInstance.tokenTransferPost(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SDTokenTransferRequest**](SDTokenTransferRequest.md)|  | 

### Return type

[**Empty**](Empty.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json