# README

Go API client for satstream_go_sdk

Satstream API

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 1.0
Package version: 1.0.45
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://satstream.io

Installation

Put the package under your project folder and add the following in import:

import "./satstream_go_sdk"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AddressesApi	GetAddress	Get /address/{address}	Get address info
AddressesApi	GetAddressBalance	Get /address/{address}/balance	Get address balance
AddressesApi	GetAddressDeltas	Get /address/{address}/deltas	Get address deltas
AddressesApi	GetAddressRuneDeltas	Get /address/{address}/deltas/runes	Get address rune deltas
AddressesApi	GetAddressUtxos	Get /address/{address}/outputs	Get UTXOs for an address
AddressesApi	ValidateAddress	Get /address/{address}/validate	Validate address
BlocksApi	GetBlockCount	Get /blockcount	Get the height of the latest block
BlocksApi	GetBlockDecoded	Get /block/raw/{identifier}/decoded	Get block by hash or height (verbosity 2)
BlocksApi	GetBlockHashByHeight	Get /blockhash/{block_height}	Returns blockhash of specified block.
BlocksApi	GetBlockHex	Get /block/raw/{identifier}/hex	Get block by hash or height (verbosity 0)
BlocksApi	GetBlockInfo	Get /block/{identifier}	Get block info by hash or height
BlocksApi	GetBlockPrevout	Get /block/raw/{identifier}/prevout	Get block by hash or height (verbosity 3)
BlocksApi	GetBlockStats	Post /block/stats	Get block stats
BlocksApi	GetBlockSummary	Get /block/raw/{identifier}/summary	Get block by hash or height (verbosity 1)
BlocksApi	GetBlockchainInfo	Get /blockchain/info	Get blockchain information
BlocksApi	GetBlocks	Get /blocks	Returns the latest block height, last 100 block hashes, and featured inscriptions
BlocksApi	GetLatestBlockHeight	Get /blockheight	Returns the height of the latest block.
BlocksApi	GetLatestBlockhash	Get /blockhash	Returns blockhash for the latest block.
BlocksApi	GetLatestBlocktime	Get /blocktime	Get the timestamp of the latest block
FeesApi	EstimateRawFee	Post /fee/estimate-raw	Estimate Raw Fee
FeesApi	EstimateSmartFee	Post /fee/estimate-smart	Estimate smart fee
InscriptionsApi	FetchInscriptionChild	Get /inscription/{inscription_id}/{child_index}	Get inscription child info
InscriptionsApi	FetchInscriptions	Post /inscriptions	Fetch multiple inscriptions
InscriptionsApi	GetBlockInscriptions	Get /inscriptions/block/{block_height}	Get inscriptions in a specific block
InscriptionsApi	GetBlockInscriptionsPage	Get /inscriptions/block/{block_height}/{page}	Get paginated inscriptions in a specific block
InscriptionsApi	GetInscription	Get /inscription/{inscription_id}	Get inscription info
InscriptionsApi	GetLatestInscriptions	Get /inscriptions	Get latest inscriptions
InscriptionsApi	GetLatestInscriptionsPage	Get /inscriptions/{page}	Get latest inscriptions page
MempoolApi	GetMempoolAncestors	Post /mempool/ancestors	Get mempool ancestors
MempoolApi	GetMempoolDescendants	Post /mempool/descendants	Get mempool descendants
MempoolApi	GetMempoolInfo	Get /mempool/info	Get mempool information
MempoolApi	GetRawMempool	Post /mempool/raw	Get raw mempool
MempoolApi	TestMempoolAccept	Post /mempool/test-accept	Test mempool accept
MiningApi	GetMiningInfo	Get /mining/info	Get mining information
MiningApi	GetNetworkHashps	Post /mining/networkhashps	Get network hash per second
NetworkApi	GetChainTxStats	Post /chain/txstats	Get chain tx stats
NetworkApi	GetDifficulty	Get /chain/difficulty	Get difficulty
OutputsApi	GetOutputByOutpoint	Get /output/{outpoint}	Get output info by outpoint
OutputsApi	GetOutputs	Post /outputs	Get multiple outputs
PSBTsApi	AnalyzePsbt	Post /psbt/analyze	Analyze PSBT
PSBTsApi	CombinePsbt	Post /psbt/combine	Combine PSBTs
PSBTsApi	CreatePsbt	Post /psbt/create	Create PSBT
PSBTsApi	DecodePsbt	Post /psbt/decode	Decode PSBT
PSBTsApi	JoinPsbts	Post /psbt/join	Join PSBTs
RunesApi	GetLatestRunes	Get /runes	Get latest runes
RunesApi	GetLatestRunesPage	Get /runes/{page}	Get latest runes page
RunesApi	GetRune	Get /rune/{identifier}	Get rune info
SatoshisApi	GetSatoshi	Get /sat/{number}	Get satoshi info
ScriptsApi	DecodeScript	Post /script/decode	Decode Script
StatusApi	GetStatus	Get /status	Get server status
TransactionsApi	CombineRawTransaction	Post /tx/combine	Combine Raw Transactions
TransactionsApi	ConvertToPsbt	Post /tx/convert-to-psbt	Convert Raw Transaction to PSBT
TransactionsApi	CreateRawTransaction	Post /tx/create	Create Raw Transaction
TransactionsApi	DecodeTxInscriptions	Get /tx/{txid}/inscriptions	Decode transaction inscriptions
TransactionsApi	GetRawTransaction	Get /tx/{txid}/raw/decode	Get raw transaction (verbosity 1)
TransactionsApi	GetRawTransactionHex	Get /tx/{txid}/hex	Get raw transaction (verbosity 0)
TransactionsApi	GetRawTransactionPrevout	Get /tx/{txid}/raw/prevout	Get raw transaction with prevouts (verbosity 2)
TransactionsApi	GetTxOut	Post /tx/out	Get transaction output
TransactionsApi	GetTxOutProof	Post /tx/outproof	Get transaction output proof
TransactionsApi	GetTxOutSetInfo	Post /tx/out/set/info	Get transaction output set information
TransactionsApi	GetTxSpendingPrevout	Post /tx/spending-prevout	Get transaction spending prevout
TransactionsApi	SendRawTransaction	Post /tx/send	Send raw transaction
TransactionsApi	VerifyTxOutProof	Post /tx/outproof/verify	Verify transaction output proof

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Type: API key

Example

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

Author

[email protected]