# Rust API client for satstream-rust-sdk

Satstream API

## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.

- API version: 1.0
- Package version: 1.0.17
- Build package: io.swagger.codegen.languages.RustClientCodegen
For more information, please visit [https://satstream.io](https://satstream.io)

## Installation
Put the package under your project folder and add the following in import:
```
    "./satstream-rust-sdk"
```

## Documentation for API Endpoints

All URIs are relative to *https://api.satstream.io/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AddressesApi* | [**get_address_balance**](docs/AddressesApi.md#get_address_balance) | **Get** /addresses/{address}/balance | Get address balance
*AddressesApi* | [**get_address_non_inscription_utxos**](docs/AddressesApi.md#get_address_non_inscription_utxos) | **Get** /addresses/{address}/utxos | Get address non-inscription UTXOs
*AddressesApi* | [**get_address_rune_balance**](docs/AddressesApi.md#get_address_rune_balance) | **Get** /addresses/{address}/runes/{runeid} | Get address rune balance
*AddressesApi* | [**get_address_runes_balance_list**](docs/AddressesApi.md#get_address_runes_balance_list) | **Get** /addresses/{address}/runes | Get address runes balance list
*AddressesApi* | [**get_address_timeframe_balance**](docs/AddressesApi.md#get_address_timeframe_balance) | **Get** /addresses/{address}/balance/timeframe | Get address timeframe balance
*BlocksApi* | [**get_block_by_hash**](docs/BlocksApi.md#get_block_by_hash) | **Get** /blocks/hash/{hash} | Get block by hash
*BlocksApi* | [**get_block_info**](docs/BlocksApi.md#get_block_info) | **Get** /blocks/{height} | Get block info
*BlocksApi* | [**get_block_transactions**](docs/BlocksApi.md#get_block_transactions) | **Get** /blocks/{height}/transactions | Get block transactions
*BlocksApi* | [**get_current_block_height**](docs/BlocksApi.md#get_current_block_height) | **Get** /blocks/current-height | Get current block height
*FeesApi* | [**get_recommended_fees**](docs/FeesApi.md#get_recommended_fees) | **Get** /fees | Get recommended fees
*MempoolApi* | [**get_address_mempool_transactions**](docs/MempoolApi.md#get_address_mempool_transactions) | **Get** /mempool/addresses/{address}/transactions | Get address mempool transactions
*MempoolApi* | [**get_mempool_transaction_info**](docs/MempoolApi.md#get_mempool_transaction_info) | **Get** /mempool/transactions/{txid} | Get mempool transaction info
*MempoolApi* | [**get_mempool_transactions**](docs/MempoolApi.md#get_mempool_transactions) | **Get** /mempool/transactions | Get mempool transactions
*RunesApi* | [**get_runes_holders**](docs/RunesApi.md#get_runes_holders) | **Get** /runes/{runeId}/holders | Get rune holders
*RunesApi* | [**get_runes_info**](docs/RunesApi.md#get_runes_info) | **Get** /runes/{runeId} | Get rune info
*RunesApi* | [**get_runes_info_list**](docs/RunesApi.md#get_runes_info_list) | **Get** /runes | Get runes info list
*TransactionsApi* | [**broadcast_transaction**](docs/TransactionsApi.md#broadcast_transaction) | **Post** /transactions/broadcast | Broadcast transaction
*TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **Get** /indexer/tx/{hash} | Get transaction
*TransactionsApi* | [**get_transaction_info**](docs/TransactionsApi.md#get_transaction_info) | **Get** /transactions/{txid} | Get transaction info


## Documentation For Models

 - [BigInt](docs/BigInt.md)
 - [GithubComSatstreamSsApiServerApiAddressesResponsesError](docs/GithubComSatstreamSsApiServerApiAddressesResponsesError.md)
 - [GithubComSatstreamSsApiServerApiBlocksResponsesError](docs/GithubComSatstreamSsApiServerApiBlocksResponsesError.md)
 - [GithubComSatstreamSsApiServerApiRunesResponsesError](docs/GithubComSatstreamSsApiServerApiRunesResponsesError.md)
 - [GithubComSatstreamSsApiServerApiTransactionsResponsesError](docs/GithubComSatstreamSsApiServerApiTransactionsResponsesError.md)
 - [GithubComSatstreamSsUtilsOrdinalsTerms](docs/GithubComSatstreamSsUtilsOrdinalsTerms.md)
 - [GithubComSatstreamSsUtilsOrdinalsTermsRange](docs/GithubComSatstreamSsUtilsOrdinalsTermsRange.md)
 - [GithubComSatstreamSsUtilsRpcBlock](docs/GithubComSatstreamSsUtilsRpcBlock.md)
 - [GithubComSatstreamSsUtilsRpcBtcTx](docs/GithubComSatstreamSsUtilsRpcBtcTx.md)
 - [GithubComSatstreamSsUtilsRpcPrevOut](docs/GithubComSatstreamSsUtilsRpcPrevOut.md)
 - [GithubComSatstreamSsUtilsRpcScriptPubKey](docs/GithubComSatstreamSsUtilsRpcScriptPubKey.md)
 - [GithubComSatstreamSsUtilsRpcScriptSig](docs/GithubComSatstreamSsUtilsRpcScriptSig.md)
 - [GithubComSatstreamSsUtilsRpcUtxoRune](docs/GithubComSatstreamSsUtilsRpcUtxoRune.md)
 - [GithubComSatstreamSsUtilsRpcVin](docs/GithubComSatstreamSsUtilsRpcVin.md)
 - [GithubComSatstreamSsUtilsRpcVout](docs/GithubComSatstreamSsUtilsRpcVout.md)
 - [GithubComSatstreamSsUtilsStoreTransactionDocument](docs/GithubComSatstreamSsUtilsStoreTransactionDocument.md)
 - [ResponsesBlockRange](docs/ResponsesBlockRange.md)
 - [ResponsesGetAddressBalance](docs/ResponsesGetAddressBalance.md)
 - [ResponsesGetAddressBalanceData](docs/ResponsesGetAddressBalanceData.md)
 - [ResponsesGetAddressMempoolTxs](docs/ResponsesGetAddressMempoolTxs.md)
 - [ResponsesGetAddressNonInscriptionUtxo](docs/ResponsesGetAddressNonInscriptionUtxo.md)
 - [ResponsesGetAddressNonInscriptionUtxoData](docs/ResponsesGetAddressNonInscriptionUtxoData.md)
 - [ResponsesGetAddressRuneBalance](docs/ResponsesGetAddressRuneBalance.md)
 - [ResponsesGetAddressRuneBalanceData](docs/ResponsesGetAddressRuneBalanceData.md)
 - [ResponsesGetAddressRunesBalanceList](docs/ResponsesGetAddressRunesBalanceList.md)
 - [ResponsesGetAddressRunesBalanceListData](docs/ResponsesGetAddressRunesBalanceListData.md)
 - [ResponsesGetAddressRunesBalanceListItem](docs/ResponsesGetAddressRunesBalanceListItem.md)
 - [ResponsesGetAddressTimeframeBalance](docs/ResponsesGetAddressTimeframeBalance.md)
 - [ResponsesGetAddressTimeframeBalanceData](docs/ResponsesGetAddressTimeframeBalanceData.md)
 - [ResponsesGetAddressTimeframeBalanceItem](docs/ResponsesGetAddressTimeframeBalanceItem.md)
 - [ResponsesGetAddressTimeframeBalanceItemBlockRange](docs/ResponsesGetAddressTimeframeBalanceItemBlockRange.md)
 - [ResponsesGetBlockByHash](docs/ResponsesGetBlockByHash.md)
 - [ResponsesGetBlockHeight](docs/ResponsesGetBlockHeight.md)
 - [ResponsesGetBlockHeightData](docs/ResponsesGetBlockHeightData.md)
 - [ResponsesGetBlockInfo](docs/ResponsesGetBlockInfo.md)
 - [ResponsesGetBlockTransactions](docs/ResponsesGetBlockTransactions.md)
 - [ResponsesGetFees](docs/ResponsesGetFees.md)
 - [ResponsesGetFeesData](docs/ResponsesGetFeesData.md)
 - [ResponsesGetMempoolTransactions](docs/ResponsesGetMempoolTransactions.md)
 - [ResponsesGetMempoolTxInfo](docs/ResponsesGetMempoolTxInfo.md)
 - [ResponsesGetRuneHolders](docs/ResponsesGetRuneHolders.md)
 - [ResponsesGetRuneHoldersData](docs/ResponsesGetRuneHoldersData.md)
 - [ResponsesGetRuneInfo](docs/ResponsesGetRuneInfo.md)
 - [ResponsesGetRunesInfoList](docs/ResponsesGetRunesInfoList.md)
 - [ResponsesGetRunesInfoListData](docs/ResponsesGetRunesInfoListData.md)
 - [ResponsesGetTransaction](docs/ResponsesGetTransaction.md)
 - [ResponsesGetTxInfo](docs/ResponsesGetTxInfo.md)
 - [ResponsesGetTxInfoData](docs/ResponsesGetTxInfoData.md)
 - [ResponsesNonInscriptionUtxo](docs/ResponsesNonInscriptionUtxo.md)
 - [ResponsesPaginationInfo](docs/ResponsesPaginationInfo.md)
 - [ResponsesRuneHolder](docs/ResponsesRuneHolder.md)
 - [ResponsesRuneInfo](docs/ResponsesRuneInfo.md)
 - [ResponsesSendRawTransaction](docs/ResponsesSendRawTransaction.md)
 - [ResponsesSendRawTransactionData](docs/ResponsesSendRawTransactionData.md)


## Documentation For Authorization

## ApiKeyAuth
- **Type**: API key 

Example
```
	auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
		Key: "APIKEY",
		Prefix: "Bearer", // Omit if not necessary.
	})
    r, err := client.Service.Operation(auth, args)
```

## Author

team@satstream.io