# \AutomaticTokensForwardingApi
All URIs are relative to *https://rest.cryptoapis.io/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add_tokens_to_existing_from_address**](AutomaticTokensForwardingApi.md#add_tokens_to_existing_from_address) | **POST** /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations/add-token | Add Tokens To Existing fromAddress
[**create_automatic_tokens_forwarding**](AutomaticTokensForwardingApi.md#create_automatic_tokens_forwarding) | **POST** /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations | Create Automatic Tokens Forwarding
[**delete_automatic_tokens_forwarding**](AutomaticTokensForwardingApi.md#delete_automatic_tokens_forwarding) | **DELETE** /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations/{referenceId} | Delete Automatic Tokens Forwarding
[**get_fee_address_details**](AutomaticTokensForwardingApi.md#get_fee_address_details) | **GET** /blockchain-automations/{blockchain}/{network}/tokens-forwarding/fee-addresses | Get Fee Address Details
[**list_tokens_forwarding_automations**](AutomaticTokensForwardingApi.md#list_tokens_forwarding_automations) | **GET** /blockchain-automations/{blockchain}/{network}/tokens-forwarding/automations | List Tokens Forwarding Automations
## add_tokens_to_existing_from_address
> crate::models::AddTokensToExistingFromAddressR add_tokens_to_existing_from_address(blockchain, network, context, add_tokens_to_existing_from_address_rb)
Add Tokens To Existing fromAddress
Through this endpoint customers can add **Automatic Tokens forwardings** to an already existing `fromAddress`. Unlike the \"Create Automatic Tokens Forwarding\" endpoint, where the `fromAddress` is generated each time, with this endpoint customers can add an automation from another token to one and the same `fromAddress`. The `fromAddress` can be used as a deposit address. Any funds received by this address will be automatically forwarded to `toAddress` based on what the customer has set for the automation. The `toAddress` is essentially the main address and destination for the automatic tokens forwarding. There is also a `minimumTransferAmount` which only when reached will then trigger the forwarding. Through this the customer can save from fees. Moreover, `feePriority` can be also set, which defines how quickly to move the tokens once they are received. The higher priority, the larger the fee will be. It can be \"SLOW\", \"STANDARD\" or \"FAST\". For this automatic forwarding the customer can set a callback subscription. {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning}
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | [required] |
**network** | **String** | Network | [required] |
**context** | Option<**String**> | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | |
**add_tokens_to_existing_from_address_rb** | Option<[**AddTokensToExistingFromAddressRb**](AddTokensToExistingFromAddressRb.md)> | | |
### Return type
[**crate::models::AddTokensToExistingFromAddressR**](AddTokensToExistingFromAddressR.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_automatic_tokens_forwarding
> crate::models::CreateAutomaticTokensForwardingR create_automatic_tokens_forwarding(blockchain, network, context, create_automatic_tokens_forwarding_rb)
Create Automatic Tokens Forwarding
Through this endpoint customers can set up an automatic forwarding function specifically for tokens (**not** coins). They can have a `toAddress` which is essentially the main address and the destination for the automatic tokens forwarding. There is also a `minimumTransferAmount` which only when reached will then trigger the forwarding. Through this the customer can save from fees. Moreover, `feePriority` can be also set, which defines how quickly to move the tokens once they are received. The higher priority, the larger the fee will be. It can be \"SLOW\", \"STANDARD\" or \"FAST\". The response of this endpoint contains an attribute `fromAddress` which can be used as a deposit address. Any funds received by this address will be automatically forwarded to `toAddress` based on what the customer has set for the automation. For this automatic forwarding the customer can set a callback subscription. {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning} {note}This endpoint generates a new `fromAddress` each time.{/note}
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | [required] |
**network** | **String** | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks. | [required] |
**context** | Option<**String**> | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | |
**create_automatic_tokens_forwarding_rb** | Option<[**CreateAutomaticTokensForwardingRb**](CreateAutomaticTokensForwardingRb.md)> | | |
### Return type
[**crate::models::CreateAutomaticTokensForwardingR**](CreateAutomaticTokensForwardingR.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_automatic_tokens_forwarding
> crate::models::DeleteAutomaticTokensForwardingR delete_automatic_tokens_forwarding(blockchain, network, reference_id, context)
Delete Automatic Tokens Forwarding
Through this endpoint customers can delete a forwarding function they have set for **tokens** (**not** coins). By setting a `fromAddress` and a `toAddress`, and specifying the amount, tokens can be transferred between addresses. A `feePriority` will be returned which represents the fee priority of the automation whether it is \"SLOW\", \"STANDARD\" OR \"FAST\". {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning}
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | [required] |
**network** | **String** | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks. | [required] |
**reference_id** | **String** | Represents a unique ID used to reference the specific callback subscription. | [required] |
**context** | Option<**String**> | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | |
### Return type
[**crate::models::DeleteAutomaticTokensForwardingR**](DeleteAutomaticTokensForwardingR.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_fee_address_details
> crate::models::GetFeeAddressDetailsR get_fee_address_details(blockchain, network, context)
Get Fee Address Details
Through this endpoint customers can obtain details about a fee address. Only one fee address per currency per network for a user's account can be set no matter how many tokens or subscriptions they have or want to automatically forward.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | [required] |
**network** | **String** | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks. | [required] |
**context** | Option<**String**> | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | |
### Return type
[**crate::models::GetFeeAddressDetailsR**](GetFeeAddressDetailsR.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_tokens_forwarding_automations
> crate::models::ListTokensForwardingAutomationsR list_tokens_forwarding_automations(blockchain, network, context, limit, offset)
List Tokens Forwarding Automations
Through this endpoint customers can list all of their **tokens** forwarding automations (**not** coins). Customers can set up automatic forwarding functions for tokens by setting a `fromAddress` and a `toAddress`, and specifying the amount that can be transferred between addresses. A `feePriority` will be returned which represents the fee priority of the automation whether it is \"SLOW\", \"STANDARD\" OR \"FAST\". {warning}The subscription will work for all incoming transactions until it is deleted. There is no need to do that for every transaction.{/warning} {note}Please note that listing data from the same type will apply pagination on the results.{/note}
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. | [required] |
**network** | **String** | Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks. | [required] |
**context** | Option<**String**> | In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user. | |
**limit** | Option<**i32**> | Defines how many items should be returned in the response per page basis. | |[default to 50]
**offset** | Option<**i32**> | The starting index of the response items, i.e. where the response should start listing the returned items. | |[default to 0]
### Return type
[**crate::models::ListTokensForwardingAutomationsR**](ListTokensForwardingAutomationsR.md)
### Authorization
[ApiKey](../README.md#ApiKey)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)