crypto_apis 1.0.0

data/docs/NewUnconfirmedCoinsTransactionsRBDataItem.md

@@ -0,0 +1,24 @@
+# CryptoApis::NewUnconfirmedCoinsTransactionsRBDataItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | Represents the address of the transaction, per which the result is returned. |  |
+| **allow_duplicates** | **Boolean** | Specifies a flag that permits or denies the creation of duplicate addresses. | [optional][default to false] |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs 2.0. | [optional] |
+| **callback_url** | **String** | Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedCoinsTransactionsRBDataItem.new(
+  address: mho4jHBcrNCncKt38trJahXakuaBnS7LK5,
+  allow_duplicates: true,
+  callback_secret_key: yourSecretKey,
+  callback_url: http://example.com
+)
+```
+

data/docs/NewUnconfirmedCoinsTransactionsRData.md

@@ -0,0 +1,18 @@
+# CryptoApis::NewUnconfirmedCoinsTransactionsRData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**NewUnconfirmedCoinsTransactionsRI**](NewUnconfirmedCoinsTransactionsRI.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedCoinsTransactionsRData.new(
+  item: null
+)
+```
+

data/docs/NewUnconfirmedCoinsTransactionsRI.md

@@ -0,0 +1,32 @@
+# CryptoApis::NewUnconfirmedCoinsTransactionsRI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. |  |
+| **callback_url** | **String** | Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. |  |
+| **confirmations_count** | **Integer** | Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block. |  |
+| **created_timestamp** | **Integer** | Defines the specific time/date when the subscription was created in Unix Timestamp. |  |
+| **event_type** | **String** | Defines the type of the specific event available for the customer to subscribe to for callback notification. |  |
+| **is_active** | **Boolean** | Defines whether the subscription is active or not. Set as boolean. |  |
+| **reference_id** | **String** | Represents a unique ID used to reference the specific callback subscription. |  |
+| **transaction_id** | **String** | Represents the unique identification string that defines the transaction. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedCoinsTransactionsRI.new(
+  callback_secret_key: yourSecretKey,
+  callback_url: https://example.com,
+  confirmations_count: 4,
+  created_timestamp: 1611238648,
+  event_type: ADDRESS_COINS_TRANSACTION_UNCONFIRMED,
+  is_active: true,
+  reference_id: bc243c86-0902-4386-b30d-e6b30fa1f2aa,
+  transaction_id: 96b4ea92dcca3a046c0ca2738ed9400f3c04f6c5f497cce4f3a148b1c948a1b3
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsR.md

@@ -0,0 +1,24 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_version** | **String** | Specifies the version of the API that incorporates this endpoint. |  |
+| **request_id** | **String** | Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request. |  |
+| **context** | **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. | [optional] |
+| **data** | [**NewUnconfirmedTokensTransactionsRData**](NewUnconfirmedTokensTransactionsRData.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsR.new(
+  api_version: 2.0,
+  request_id: 601c1710034ed6d407996b30,
+  context: You can add any text here,
+  data: null
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsRB.md

@@ -0,0 +1,20 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsRB
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | **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. | [optional] |
+| **data** | [**NewUnconfirmedTokensTransactionsRBData**](NewUnconfirmedTokensTransactionsRBData.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsRB.new(
+  context: null,
+  data: null
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsRBData.md

@@ -0,0 +1,18 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsRBData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**NewUnconfirmedTokensTransactionsRBDataItem**](NewUnconfirmedTokensTransactionsRBDataItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsRBData.new(
+  item: null
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsRBDataItem.md

@@ -0,0 +1,24 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsRBDataItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | Represents the address of the transaction, per which the result is returned. |  |
+| **allow_duplicates** | **Boolean** | Specifies a flag that permits or denies the creation of duplicate addresses. | [optional][default to false] |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsRBDataItem.new(
+  address: mho4jHBcrNCncKt38trJahXakuaBnS7LK5,
+  allow_duplicates: true,
+  callback_secret_key: yourSecretKey,
+  callback_url: http://example.com
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsRData.md

@@ -0,0 +1,18 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsRData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**NewUnconfirmedTokensTransactionsRI**](NewUnconfirmedTokensTransactionsRI.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsRData.new(
+  item: null
+)
+```
+

data/docs/NewUnconfirmedTokensTransactionsRI.md

@@ -0,0 +1,32 @@
+# CryptoApis::NewUnconfirmedTokensTransactionsRI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | Defines the type of the specific event available for the customer to subscribe to for callback notification. |  |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. |  |
+| **callback_url** | **String** | Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. |  |
+| **created_timestamp** | **Integer** | Defines the specific time/date when the subscription was created in Unix Timestamp. |  |
+| **event_type** | **String** | Defines the type of the specific event available for the customer to subscribe to for callback notification. |  |
+| **is_active** | **Boolean** | Defines whether the subscription is active or not. Set as boolean. |  |
+| **reference_id** | **String** | Represents a unique ID used to reference the specific callback subscription. |  |
+| **transaction_id** | **String** | Represents the unique identification string that defines the transaction. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::NewUnconfirmedTokensTransactionsRI.new(
+  address: 15XyNC88pujwuuur8DCsXBCfEhJJMzHayU,
+  callback_secret_key: yourSecretKey,
+  callback_url: https://example.com,
+  created_timestamp: 1611238648,
+  event_type: ADDRESS_TOKENS_TRANSACTION_UNCONFIRMED,
+  is_active: true,
+  reference_id: c748624f-1843-4738-a7de-8258ada0f524,
+  transaction_id: f43676625cc8a8d0ccd98a3795ad5369187cd5b279c3d06f99601566713aa961
+)
+```
+

data/docs/OmniLayerApi.md

@@ -0,0 +1,667 @@
+# CryptoApis::OmniLayerApi
+
+All URIs are relative to *https://rest.cryptoapis.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_omni_transaction_details_by_transaction_id__txid**](OmniLayerApi.md#get_omni_transaction_details_by_transaction_id__txid) | **GET** /blockchain-data/{blockchain}/{network}/omni/transactions/{transactionId} | Get Omni Transaction Details By Transaction ID (Txid) |
+| [**get_unconfirmed_omni_transaction_by_transaction_id__txid**](OmniLayerApi.md#get_unconfirmed_omni_transaction_by_transaction_id__txid) | **GET** /blockchain-data/{blockchain}/{network}/omni/transactions-unconfirmed/{transactionId} | Get Unconfirmed Omni Transaction By Transaction ID (Txid) |
+| [**list_omni_tokens_by_address**](OmniLayerApi.md#list_omni_tokens_by_address) | **GET** /blockchain-data/{blockchain}/{network}/omni/addresses/{address} | List Omni Tokens By Address |
+| [**list_omni_transactions_by_address**](OmniLayerApi.md#list_omni_transactions_by_address) | **GET** /blockchain-data/{blockchain}/{network}/omni/addresses/{address}/transactions | List Omni Transactions By Address |
+| [**list_omni_transactions_by_block_hash**](OmniLayerApi.md#list_omni_transactions_by_block_hash) | **GET** /blockchain-data/{blockchain}/{network}/omni/blocks/hash/{blockHash}/transactions | List Omni Transactions By Block Hash |
+| [**list_omni_transactions_by_block_height**](OmniLayerApi.md#list_omni_transactions_by_block_height) | **GET** /blockchain-data/{blockchain}/{network}/omni/blocks/height/{blockHeight}/transactions | List Omni Transactions By Block Height |
+| [**list_unconfirmed_omni_transactions_by_address**](OmniLayerApi.md#list_unconfirmed_omni_transactions_by_address) | **GET** /blockchain-data/{blockchain}/{network}/omni/address-transactions-unconfirmed/{address} | List Unconfirmed Omni Transactions By Address |
+| [**list_unconfirmed_omni_transactions_by_property_id**](OmniLayerApi.md#list_unconfirmed_omni_transactions_by_property_id) | **GET** /blockchain-data/{blockchain}/{network}/omni/properties/{propertyId}/transactions | List Unconfirmed Omni Transactions By Property ID |
+
+
+## get_omni_transaction_details_by_transaction_id__txid
+
+> <GetOmniTransactionDetailsByTransactionIDTxidR> get_omni_transaction_details_by_transaction_id__txid(network, blockchain, transaction_id, opts)
+
+Get Omni Transaction Details By Transaction ID (Txid)
+
+Through this endpoint customers can obtain details about an Omni transaction by the transaction's unique identifier. The transaction can return information such as hash, height, time of creation in Unix timestamp, etc.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+transaction_id = 'd237ff4a681617b767bf22c4e1e8f5115b95c8c168d6cf53bbdec68529f91ecb' # String | Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.
+opts = {
+  context: 'context_example' # 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.
+}
+
+begin
+  # Get Omni Transaction Details By Transaction ID (Txid)
+  result = api_instance.get_omni_transaction_details_by_transaction_id__txid(network, blockchain, transaction_id, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->get_omni_transaction_details_by_transaction_id__txid: #{e}"
+end
+```
+
+#### Using the get_omni_transaction_details_by_transaction_id__txid_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetOmniTransactionDetailsByTransactionIDTxidR>, Integer, Hash)> get_omni_transaction_details_by_transaction_id__txid_with_http_info(network, blockchain, transaction_id, opts)
+
+```ruby
+begin
+  # Get Omni Transaction Details By Transaction ID (Txid)
+  data, status_code, headers = api_instance.get_omni_transaction_details_by_transaction_id__txid_with_http_info(network, blockchain, transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetOmniTransactionDetailsByTransactionIDTxidR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->get_omni_transaction_details_by_transaction_id__txid_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **transaction_id** | **String** | Represents the unique identifier of a transaction, i.e. it could be &#x60;transactionId&#x60; in UTXO-based protocols like Bitcoin, and transaction &#x60;hash&#x60; in Ethereum blockchain. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+
+### Return type
+
+[**GetOmniTransactionDetailsByTransactionIDTxidR**](GetOmniTransactionDetailsByTransactionIDTxidR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_unconfirmed_omni_transaction_by_transaction_id__txid
+
+> <GetUnconfirmedOmniTransactionByTransactionIDTxidR> get_unconfirmed_omni_transaction_by_transaction_id__txid(network, blockchain, transaction_id, opts)
+
+Get Unconfirmed Omni Transaction By Transaction ID (Txid)
+
+Through this endpoint customers can obtain information on unconfirmed Omni transactions by an attribute `transactionId`. The transaction can have information such as hash, height, time of creation in Unix timestamp, etc.    Unconfirmed transactions are usually put in the Mempool and await verification so that they can be added to a block.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+transaction_id = '92f17d3d16a1baf7de570a86179cc263cb9866c66778feec2dce111430f41c08' # String | Represents the unique identifier of a transaction, i.e. it could be `transactionId` in UTXO-based protocols like Bitcoin, and transaction `hash` in Ethereum blockchain.
+opts = {
+  context: 'context_example' # 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.
+}
+
+begin
+  # Get Unconfirmed Omni Transaction By Transaction ID (Txid)
+  result = api_instance.get_unconfirmed_omni_transaction_by_transaction_id__txid(network, blockchain, transaction_id, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->get_unconfirmed_omni_transaction_by_transaction_id__txid: #{e}"
+end
+```
+
+#### Using the get_unconfirmed_omni_transaction_by_transaction_id__txid_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUnconfirmedOmniTransactionByTransactionIDTxidR>, Integer, Hash)> get_unconfirmed_omni_transaction_by_transaction_id__txid_with_http_info(network, blockchain, transaction_id, opts)
+
+```ruby
+begin
+  # Get Unconfirmed Omni Transaction By Transaction ID (Txid)
+  data, status_code, headers = api_instance.get_unconfirmed_omni_transaction_by_transaction_id__txid_with_http_info(network, blockchain, transaction_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUnconfirmedOmniTransactionByTransactionIDTxidR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->get_unconfirmed_omni_transaction_by_transaction_id__txid_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **transaction_id** | **String** | Represents the unique identifier of a transaction, i.e. it could be &#x60;transactionId&#x60; in UTXO-based protocols like Bitcoin, and transaction &#x60;hash&#x60; in Ethereum blockchain. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+
+### Return type
+
+[**GetUnconfirmedOmniTransactionByTransactionIDTxidR**](GetUnconfirmedOmniTransactionByTransactionIDTxidR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_omni_tokens_by_address
+
+> <ListOmniTokensByAddressR> list_omni_tokens_by_address(network, blockchain, address, opts)
+
+List Omni Tokens By Address
+
+Through this endpoint the customer can receive basic information about a given Omni address based on confirmed/synced blocks only. In the case where there are any incoming or outgoing **unconfirmed** transactions for the specific address, they **will not** be counted or calculated here.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+address = 'mi7iSsKcvyFYNsiYdDZqJmH75RmoHomwmo' # String | Represents the public address, which is a compressed and shortened form of a public key.
+opts = {
+  context: 'context_example' # 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.
+}
+
+begin
+  # List Omni Tokens By Address
+  result = api_instance.list_omni_tokens_by_address(network, blockchain, address, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_tokens_by_address: #{e}"
+end
+```
+
+#### Using the list_omni_tokens_by_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListOmniTokensByAddressR>, Integer, Hash)> list_omni_tokens_by_address_with_http_info(network, blockchain, address, opts)
+
+```ruby
+begin
+  # List Omni Tokens By Address
+  data, status_code, headers = api_instance.list_omni_tokens_by_address_with_http_info(network, blockchain, address, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListOmniTokensByAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_tokens_by_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **address** | **String** | Represents the public address, which is a compressed and shortened form of a public key. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+
+### Return type
+
+[**ListOmniTokensByAddressR**](ListOmniTokensByAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_omni_transactions_by_address
+
+> <ListOmniTransactionsByAddressR> list_omni_transactions_by_address(network, blockchain, address, opts)
+
+List Omni Transactions By Address
+
+This endpoint will list Omni transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+address = 'mi7iSsKcvyFYNsiYdDZqJmH75RmoHomwmo' # String | Represents the public address, which is a compressed and shortened form of a public key.
+opts = {
+  context: 'context_example', # 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: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Omni Transactions By Address
+  result = api_instance.list_omni_transactions_by_address(network, blockchain, address, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_address: #{e}"
+end
+```
+
+#### Using the list_omni_transactions_by_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListOmniTransactionsByAddressR>, Integer, Hash)> list_omni_transactions_by_address_with_http_info(network, blockchain, address, opts)
+
+```ruby
+begin
+  # List Omni Transactions By Address
+  data, status_code, headers = api_instance.list_omni_transactions_by_address_with_http_info(network, blockchain, address, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListOmniTransactionsByAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **address** | **String** | Represents the public address, which is a compressed and shortened form of a public key. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListOmniTransactionsByAddressR**](ListOmniTransactionsByAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_omni_transactions_by_block_hash
+
+> <ListOmniTransactionsByBlockHashR> list_omni_transactions_by_block_hash(network, blockchain, block_hash, opts)
+
+List Omni Transactions By Block Hash
+
+This endpoint will list Omni transactions by an attribute `transactionHash`. The transactions listed will detail additional information such as addresses, height, time of creation in Unix timestamp, etc.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+block_hash = '000000000000001f50c9d33d122562daa7fc9582df0b415e626216c37d015818' # String | Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
+opts = {
+  context: 'context_example', # 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: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Omni Transactions By Block Hash
+  result = api_instance.list_omni_transactions_by_block_hash(network, blockchain, block_hash, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_block_hash: #{e}"
+end
+```
+
+#### Using the list_omni_transactions_by_block_hash_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListOmniTransactionsByBlockHashR>, Integer, Hash)> list_omni_transactions_by_block_hash_with_http_info(network, blockchain, block_hash, opts)
+
+```ruby
+begin
+  # List Omni Transactions By Block Hash
+  data, status_code, headers = api_instance.list_omni_transactions_by_block_hash_with_http_info(network, blockchain, block_hash, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListOmniTransactionsByBlockHashR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_block_hash_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **block_hash** | **String** | Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListOmniTransactionsByBlockHashR**](ListOmniTransactionsByBlockHashR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_omni_transactions_by_block_height
+
+> <ListOmniTransactionsByBlockHeightR> list_omni_transactions_by_block_height(network, blockchain, block_height, opts)
+
+List Omni Transactions By Block Height
+
+This endpoint will list Omni transactions by an attribute `blockHeight`. The transactions listed will detail additional information such as hash, addresses, time of creation in Unix timestamp, etc.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+block_height = '1941222' # String | Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \"Genesis block\".
+opts = {
+  context: 'context_example', # 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: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Omni Transactions By Block Height
+  result = api_instance.list_omni_transactions_by_block_height(network, blockchain, block_height, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_block_height: #{e}"
+end
+```
+
+#### Using the list_omni_transactions_by_block_height_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListOmniTransactionsByBlockHeightR>, Integer, Hash)> list_omni_transactions_by_block_height_with_http_info(network, blockchain, block_height, opts)
+
+```ruby
+begin
+  # List Omni Transactions By Block Height
+  data, status_code, headers = api_instance.list_omni_transactions_by_block_height_with_http_info(network, blockchain, block_height, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListOmniTransactionsByBlockHeightR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_omni_transactions_by_block_height_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **block_height** | **String** | Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the \&quot;Genesis block\&quot;. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListOmniTransactionsByBlockHeightR**](ListOmniTransactionsByBlockHeightR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_unconfirmed_omni_transactions_by_address
+
+> <ListUnconfirmedOmniTransactionsByAddressR> list_unconfirmed_omni_transactions_by_address(network, blockchain, address, opts)
+
+List Unconfirmed Omni Transactions By Address
+
+This endpoint will list unconfirmed Omni transactions by an attribute `address`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.    Unconfirmed transactions are usually put in the Mempool and await verification so that they can be added to a block.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+address = 'mi7iSsKcvyFYNsiYdDZqJmH75RmoHomwmo' # String | Represents the public address, which is a compressed and shortened form of a public key.
+opts = {
+  context: 'context_example', # 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: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Unconfirmed Omni Transactions By Address
+  result = api_instance.list_unconfirmed_omni_transactions_by_address(network, blockchain, address, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_unconfirmed_omni_transactions_by_address: #{e}"
+end
+```
+
+#### Using the list_unconfirmed_omni_transactions_by_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListUnconfirmedOmniTransactionsByAddressR>, Integer, Hash)> list_unconfirmed_omni_transactions_by_address_with_http_info(network, blockchain, address, opts)
+
+```ruby
+begin
+  # List Unconfirmed Omni Transactions By Address
+  data, status_code, headers = api_instance.list_unconfirmed_omni_transactions_by_address_with_http_info(network, blockchain, address, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListUnconfirmedOmniTransactionsByAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_unconfirmed_omni_transactions_by_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **address** | **String** | Represents the public address, which is a compressed and shortened form of a public key. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListUnconfirmedOmniTransactionsByAddressR**](ListUnconfirmedOmniTransactionsByAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_unconfirmed_omni_transactions_by_property_id
+
+> <ListUnconfirmedOmniTransactionsByPropertyIDR> list_unconfirmed_omni_transactions_by_property_id(network, blockchain, property_id, opts)
+
+List Unconfirmed Omni Transactions By Property ID
+
+This endpoint will list unconfirmed Omni transactions by an attribute `propertyId`. The transactions listed will detail additional information such as hash, height, time of creation in Unix timestamp, etc.    Unconfirmed transactions are usually put in the Mempool and await verification so that they can be added to a block.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::OmniLayerApi.new
+network = 'mainnet' # 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.
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
+property_id = '2' # String | Represents the identifier of the tokens to send.
+opts = {
+  context: 'context_example', # 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: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Unconfirmed Omni Transactions By Property ID
+  result = api_instance.list_unconfirmed_omni_transactions_by_property_id(network, blockchain, property_id, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_unconfirmed_omni_transactions_by_property_id: #{e}"
+end
+```
+
+#### Using the list_unconfirmed_omni_transactions_by_property_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListUnconfirmedOmniTransactionsByPropertyIDR>, Integer, Hash)> list_unconfirmed_omni_transactions_by_property_id_with_http_info(network, blockchain, property_id, opts)
+
+```ruby
+begin
+  # List Unconfirmed Omni Transactions By Property ID
+  data, status_code, headers = api_instance.list_unconfirmed_omni_transactions_by_property_id_with_http_info(network, blockchain, property_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListUnconfirmedOmniTransactionsByPropertyIDR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling OmniLayerApi->list_unconfirmed_omni_transactions_by_property_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \&quot;mainnet\&quot; is the live network with actual data while networks like \&quot;testnet\&quot;, \&quot;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc. |  |
+| **property_id** | **String** | Represents the identifier of the tokens to send. |  |
+| **context** | **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. &#x60;context&#x60; is specified by the user. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListUnconfirmedOmniTransactionsByPropertyIDR**](ListUnconfirmedOmniTransactionsByPropertyIDR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+