mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-04-28 21:05:36 +08:00
Feat/27 documentation conventions (#900) - Fixes https://github.com/hirosystems/docs/issues/27
* Updated API Descriptions * Updated Tags from linting * Updated postman link, descriptions * Merged with Linting changes * Fixed Tags for Stacking Rewards, Fees and Names * Updated API Descriptions * Updated Tags from linting * Updated postman link, descriptions * Merged with Linting changes * Fixed Tags for Stacking Rewards, Fees and Names
This commit is contained in:
@@ -13,7 +13,6 @@ info:
|
||||
Welcome to the API reference overview for the <a href="https://docs.hiro.so/get-started/stacks-blockchain-api">Stacks Blockchain API</a>.
|
||||
|
||||
<a href="https://hirosystems.github.io/stacks-blockchain-api/collection.json" download="stacks-api-collection.json">Download Postman collection</a>
|
||||
|
||||
tags:
|
||||
- name: Accounts
|
||||
description: Read-only endpoints to obtain Stacks account details
|
||||
@@ -89,7 +88,7 @@ paths:
|
||||
default: false
|
||||
post:
|
||||
summary: Get STX tokens
|
||||
description: Get STX tokens for the testnet
|
||||
description: Retrieves STX tokens into you TestNet STX address.
|
||||
tags:
|
||||
- Faucets
|
||||
operationId: run_faucet_stx
|
||||
@@ -114,7 +113,7 @@ paths:
|
||||
type: string
|
||||
post:
|
||||
summary: Get BTC tokens
|
||||
description: Get BTC tokens for the testnet
|
||||
description: Retrieves BTC tokens into your TestNet BTC address.
|
||||
tags:
|
||||
- Faucets
|
||||
operationId: run_faucet_btc
|
||||
@@ -137,7 +136,7 @@ paths:
|
||||
- Transactions
|
||||
operationId: get_transaction_list
|
||||
description: |
|
||||
Get all recently mined transactions
|
||||
Retrieves all recently mined transactions
|
||||
|
||||
If using TypeScript, import typings for this response from our types package:
|
||||
|
||||
@@ -189,7 +188,7 @@ paths:
|
||||
tags:
|
||||
- Transactions
|
||||
operationId: get_mempool_transaction_list
|
||||
description: Get all recently-broadcast mempool transactions
|
||||
description: Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
|
||||
parameters:
|
||||
- name: sender_address
|
||||
in: query
|
||||
@@ -246,7 +245,13 @@ paths:
|
||||
tags:
|
||||
- Transactions
|
||||
operationId: get_dropped_mempool_transaction_list
|
||||
description: Get all recently-broadcast mempool transactions
|
||||
description: |
|
||||
Retrieves all recently-broadcast transactions that have been dropped from the mempool.
|
||||
|
||||
Transactions are dropped from the mempool if:
|
||||
* they were stale and awaiting garbage collection or,
|
||||
* were expensive, or
|
||||
* were replaced with a new fee
|
||||
parameters:
|
||||
- name: limit
|
||||
in: query
|
||||
@@ -307,7 +312,7 @@ paths:
|
||||
- Transactions
|
||||
operationId: get_tx_list_details
|
||||
description: |
|
||||
Get an array of transactions by IDs
|
||||
Retrieves a list of transactions for a given list of transaction IDs
|
||||
|
||||
If using TypeScript, import typings for this response from our types package:
|
||||
|
||||
@@ -357,7 +362,7 @@ paths:
|
||||
- Transactions
|
||||
operationId: get_transaction_by_id
|
||||
description: |
|
||||
Get a specific transaction by ID
|
||||
Retrieves transaction details for a given transaction ID
|
||||
|
||||
`import type { Transaction } from '@stacks/stacks-blockchain-api-types';`
|
||||
responses:
|
||||
@@ -386,8 +391,7 @@ paths:
|
||||
- Transactions
|
||||
operationId: get_raw_transaction_by_id
|
||||
description: |
|
||||
Get raw transaction by ID
|
||||
|
||||
Retrieves a hex encoded serialized transaction for a given ID
|
||||
responses:
|
||||
200:
|
||||
description: Hex encoded serialized transaction
|
||||
@@ -405,7 +409,7 @@ paths:
|
||||
summary: Broadcast raw transaction
|
||||
tags:
|
||||
- Transactions
|
||||
description: Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/hirosystems/stacks.js) project to generate a raw transaction payload.
|
||||
description: Broadcast raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload.
|
||||
operationId: post_core_node_transactions
|
||||
requestBody:
|
||||
content:
|
||||
@@ -491,7 +495,7 @@ paths:
|
||||
/extended/v1/microblock/unanchored/txs:
|
||||
get:
|
||||
summary: Get the list of current transactions that belong to unanchored microblocks
|
||||
description: This contains transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
|
||||
description: Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
|
||||
tags:
|
||||
- Microblocks
|
||||
operationId: get_unanchored_txs
|
||||
@@ -506,7 +510,7 @@ paths:
|
||||
/extended/v1/block:
|
||||
get:
|
||||
summary: Get recent blocks
|
||||
description: Get all recently mined blocks
|
||||
description: Retrieves a list of recently mined blocks
|
||||
tags:
|
||||
- Blocks
|
||||
operationId: get_block_list
|
||||
@@ -543,8 +547,8 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
get:
|
||||
summary: Get block
|
||||
description: Get a specific block by hash
|
||||
summary: Get block by hash
|
||||
description: Retrieves block details of a specific block for a given chain height
|
||||
tags:
|
||||
- Blocks
|
||||
operationId: get_block_by_hash
|
||||
@@ -572,8 +576,8 @@ paths:
|
||||
schema:
|
||||
type: number
|
||||
get:
|
||||
summary: Get block
|
||||
description: Get a specific block by height
|
||||
summary: Get block by height
|
||||
description: Retrieves block details of a specific block at a given block height
|
||||
tags:
|
||||
- Blocks
|
||||
operationId: get_block_by_height
|
||||
@@ -601,8 +605,8 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
get:
|
||||
summary: Get block
|
||||
description: Get a specific block by burnchain block hash
|
||||
summary: Get block by burnchain block hash
|
||||
description: Retrieves block details of a specific block for a given burnchain block hash
|
||||
tags:
|
||||
- Blocks
|
||||
operationId: get_block_by_burn_block_hash
|
||||
@@ -631,8 +635,8 @@ paths:
|
||||
schema:
|
||||
type: number
|
||||
get:
|
||||
summary: Get block
|
||||
description: Get a specific block by burn chain height
|
||||
summary: Get block by burnchain height
|
||||
description: Retrieves block details of a specific block for a given burn chain height
|
||||
tags:
|
||||
- Blocks
|
||||
operationId: get_block_by_burn_block_height
|
||||
@@ -655,7 +659,7 @@ paths:
|
||||
/extended/v1/burnchain/reward_slot_holders:
|
||||
get:
|
||||
summary: Get recent reward slot holders
|
||||
description: Array of the Bitcoin addresses that would validly receive PoX commitments.
|
||||
description: Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.
|
||||
tags:
|
||||
- Stacking Rewards
|
||||
operationId: get_burnchain_reward_slot_holders
|
||||
@@ -687,7 +691,7 @@ paths:
|
||||
/extended/v1/burnchain/reward_slot_holders/{address}:
|
||||
get:
|
||||
summary: Get recent reward slot holder entries for the given address
|
||||
description: Array of the Bitcoin addresses that would validly receive PoX commitments.
|
||||
description: Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.
|
||||
tags:
|
||||
- Stacking Rewards
|
||||
operationId: get_burnchain_reward_slot_holders_by_address
|
||||
@@ -723,7 +727,7 @@ paths:
|
||||
/extended/v1/burnchain/rewards:
|
||||
get:
|
||||
summary: Get recent burnchain reward recipients
|
||||
description: Get a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
||||
description: Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
||||
tags:
|
||||
- Stacking Rewards
|
||||
operationId: get_burnchain_reward_list
|
||||
@@ -754,7 +758,7 @@ paths:
|
||||
/extended/v1/burnchain/rewards/{address}:
|
||||
get:
|
||||
summary: Get recent burnchain reward for the given recipient
|
||||
description: Get a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
||||
description: Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
||||
tags:
|
||||
- Stacking Rewards
|
||||
operationId: get_burnchain_reward_list_by_address
|
||||
@@ -789,7 +793,7 @@ paths:
|
||||
/extended/v1/burnchain/rewards/{address}/total:
|
||||
get:
|
||||
summary: Get total burnchain rewards for the given recipient
|
||||
description: Get the total burnchain (e.g. Bitcoin) rewards for the given recipient
|
||||
description: Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient
|
||||
tags:
|
||||
- Stacking Rewards
|
||||
operationId: get_burnchain_rewards_total_by_address
|
||||
@@ -813,7 +817,7 @@ paths:
|
||||
/extended/v1/contract/{contract_id}:
|
||||
get:
|
||||
summary: Get contract info
|
||||
description: Get contract info using the contract ID
|
||||
description: Retrieves details of a contract with a given contract ID
|
||||
tags:
|
||||
- Smart Contracts
|
||||
operationId: get_contract_by_id
|
||||
@@ -846,7 +850,7 @@ paths:
|
||||
/extended/v1/contract/by_trait:
|
||||
get:
|
||||
summary: Get contracts by trait
|
||||
description: Get all contracts implement a given trait
|
||||
description: Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens
|
||||
tags:
|
||||
- Smart Contracts
|
||||
operationId: get_contracts_by_trait
|
||||
@@ -862,7 +866,7 @@ paths:
|
||||
parameters:
|
||||
- name: trait_abi
|
||||
in: query
|
||||
description: JSON abi of the trait
|
||||
description: JSON abi of the trait.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
@@ -882,7 +886,7 @@ paths:
|
||||
/extended/v1/contract/{contract_id}/events:
|
||||
get:
|
||||
summary: Get contract events
|
||||
description: Get contract events using a contract ID
|
||||
description: Retrieves a list of events that have been triggered by a given Contract Id
|
||||
tags:
|
||||
- Smart Contracts
|
||||
operationId: get_contract_events_by_id
|
||||
@@ -925,7 +929,7 @@ paths:
|
||||
/v2/contracts/interface/{contract_address}/{contract_name}:
|
||||
get:
|
||||
summary: Get contract interface
|
||||
description: Get contract interface using a `contract_address` and `contract name`
|
||||
description: Retrieves a contract interface with a given `contract_address` and `contract name`
|
||||
tags:
|
||||
- Smart Contracts
|
||||
operationId: get_contract_interface
|
||||
@@ -1024,7 +1028,7 @@ paths:
|
||||
tags:
|
||||
- Smart Contracts
|
||||
operationId: get_contract_source
|
||||
description: Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
||||
description: Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1122,6 +1126,7 @@ paths:
|
||||
/extended/v1/address/{principal}/balances:
|
||||
get:
|
||||
summary: Get account balances
|
||||
description: Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_balance
|
||||
@@ -1158,6 +1163,7 @@ paths:
|
||||
/extended/v1/address/{principal}/stx:
|
||||
get:
|
||||
summary: Get account STX balance
|
||||
description: Retrieves STX token balance for a given Address or Contract Identifier.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_stx_balance
|
||||
@@ -1194,6 +1200,7 @@ paths:
|
||||
/extended/v1/address/{principal}/transactions:
|
||||
get:
|
||||
summary: Get account transactions
|
||||
description: Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_transactions
|
||||
@@ -1248,6 +1255,7 @@ paths:
|
||||
/extended/v1/address/{principal}/{tx_id}/with_transfers:
|
||||
get:
|
||||
summary: Get account transaction information for specific transaction
|
||||
description: Retrieves transaction details for a given Transcation Id, for a given account or contract Identifier.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_single_transaction_with_transfers
|
||||
@@ -1283,6 +1291,7 @@ paths:
|
||||
/extended/v1/address/{principal}/transactions_with_transfers:
|
||||
get:
|
||||
summary: Get account transactions including STX transfers for each transaction.
|
||||
description: Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_transactions_with_transfers
|
||||
@@ -1336,7 +1345,8 @@ paths:
|
||||
|
||||
/extended/v1/address/{principal}/nonces:
|
||||
get:
|
||||
summary: Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
|
||||
summary: Get the latest nonce used by an account
|
||||
description: Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_nonces
|
||||
@@ -1360,6 +1370,7 @@ paths:
|
||||
/extended/v1/address/{principal}/assets:
|
||||
get:
|
||||
summary: Get account assets
|
||||
description: Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_assets
|
||||
@@ -1409,7 +1420,7 @@ paths:
|
||||
get:
|
||||
summary: Get inbound STX transfers
|
||||
description: |
|
||||
Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,
|
||||
Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,
|
||||
and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
|
||||
tags:
|
||||
- Accounts
|
||||
@@ -1466,7 +1477,7 @@ paths:
|
||||
get:
|
||||
summary: Get nft events
|
||||
description: |
|
||||
Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
|
||||
Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get_account_nft
|
||||
@@ -1519,7 +1530,7 @@ paths:
|
||||
- Accounts
|
||||
operationId: get_account_info
|
||||
description: |
|
||||
Get the account data for the provided principal
|
||||
Retrieves the account data for the a given Account or a Contract Identifier
|
||||
|
||||
Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.
|
||||
|
||||
@@ -1557,7 +1568,7 @@ paths:
|
||||
tags:
|
||||
- Fees
|
||||
operationId: get_fee_transfer
|
||||
description: Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
||||
description: Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1571,7 +1582,7 @@ paths:
|
||||
/v2/info:
|
||||
get:
|
||||
summary: Get Core API info
|
||||
description: Get Core API information
|
||||
description: Retrieves information about the Core API including the server version
|
||||
tags:
|
||||
- Info
|
||||
operationId: get_core_api_info
|
||||
@@ -1587,7 +1598,7 @@ paths:
|
||||
/extended/v1/status:
|
||||
get:
|
||||
summary: Get Blockchain API status
|
||||
description: Get Blockchain API status
|
||||
description: Retrieves Blockchain API status, including the server version
|
||||
tags:
|
||||
- Info
|
||||
operationId: get_status
|
||||
@@ -1607,6 +1618,7 @@ paths:
|
||||
- Info
|
||||
operationId: get_network_block_times
|
||||
summary: Get the network target block time
|
||||
description: Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1622,6 +1634,9 @@ paths:
|
||||
- Info
|
||||
operationId: get_network_block_time_by_network
|
||||
summary: Get a given network's target block time
|
||||
description: Retrieves the target block time for a given network. The network can be
|
||||
mainnet or testnet. The block time is hardcoded and will change
|
||||
throughout the implementation phases of the testnet.
|
||||
parameters:
|
||||
- in: path
|
||||
name: network
|
||||
@@ -1646,6 +1661,7 @@ paths:
|
||||
- Info
|
||||
operationId: get_stx_supply
|
||||
summary: Get total and unlocked STX supply
|
||||
description: Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
|
||||
parameters:
|
||||
- in: query
|
||||
name: height
|
||||
@@ -1669,6 +1685,7 @@ paths:
|
||||
- Info
|
||||
operationId: get_stx_supply_total_supply_plain
|
||||
summary: Get total STX supply in plain text format
|
||||
description: Retrieves the total supply for STX tokens as plain text.
|
||||
responses:
|
||||
200:
|
||||
description: success
|
||||
@@ -1684,6 +1701,7 @@ paths:
|
||||
- Info
|
||||
operationId: get_stx_supply_circulating_plain
|
||||
summary: Get circulating STX supply in plain text format
|
||||
description: Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
|
||||
responses:
|
||||
200:
|
||||
description: success
|
||||
@@ -1699,6 +1717,7 @@ paths:
|
||||
- Info
|
||||
operationId: get_total_stx_supply_legacy_format
|
||||
summary: Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
|
||||
description: Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
|
||||
parameters:
|
||||
- in: query
|
||||
name: height
|
||||
@@ -1718,8 +1737,8 @@ paths:
|
||||
|
||||
/v2/pox:
|
||||
get:
|
||||
summary: Get PoX details
|
||||
description: Get Proof of Transfer (PoX) information. Can be used for Stacking.
|
||||
summary: Get Proof-of-Transfer details
|
||||
description: Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.
|
||||
tags:
|
||||
- Info
|
||||
operationId: get_pox_info
|
||||
@@ -1774,7 +1793,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get List of Available Networks
|
||||
operationId: rosetta_network_list
|
||||
description: This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.
|
||||
description: Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1796,7 +1815,7 @@ paths:
|
||||
summary: Get Network Options
|
||||
operationId: rosetta_network_options
|
||||
description: |
|
||||
This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier.
|
||||
Retrieves the version information and allowed network-specific types for a NetworkIdentifier.
|
||||
Any NetworkIdentifier returned by /network/list should be accessible here.
|
||||
Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.
|
||||
responses:
|
||||
@@ -1826,7 +1845,7 @@ paths:
|
||||
summary: Get Network Status
|
||||
operationId: rosetta_network_status
|
||||
description: |
|
||||
This endpoint returns the current status of the network requested.
|
||||
Retrieves the current status of the network requested.
|
||||
Any NetworkIdentifier returned by /network/list should be accessible here.
|
||||
responses:
|
||||
200:
|
||||
@@ -1883,7 +1902,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get a Block
|
||||
operationId: rosetta_block
|
||||
description: A BlockRequest is utilized to make a block request on the /block endpoint.
|
||||
description: Retrieves the Block information for a given block identifier including a list of all transactions in the block.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1910,7 +1929,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get a Block Transaction
|
||||
operationId: rosetta_block_transaction
|
||||
description: A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
|
||||
description: Retrieves a Transaction included in a block that is not returned in a BlockResponse.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1937,7 +1956,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get All Mempool Transactions
|
||||
operationId: rosetta_mempool
|
||||
description: Get all Transaction Identifiers in the mempool.
|
||||
description: Retrieves a list of transcations currently in the mempool for a given network.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1964,7 +1983,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get a Mempool Transaction
|
||||
operationId: rosetta_mempool_transaction
|
||||
description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
|
||||
description: Retrieves transaction details from the mempool for a given transaction id from a given network.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -1991,7 +2010,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Derive an AccountIdentifier from a PublicKey
|
||||
operationId: rosetta_construction_derive
|
||||
description: TODO
|
||||
description: Retrieves the Account Identifier information based on a Public Key for a given network
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -2018,7 +2037,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get the Hash of a Signed Transaction
|
||||
operationId: rosetta_construction_hash
|
||||
description: TODO
|
||||
description: Retrieves the network-specific transaction hash for a signed transaction.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -2045,7 +2064,7 @@ paths:
|
||||
- Rosetta
|
||||
summary: Get Metadata for Transaction Construction
|
||||
operationId: rosetta_construction_metadata
|
||||
description: TODO
|
||||
description: To Do
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -2204,7 +2223,7 @@ paths:
|
||||
/v2/prices/namespaces/{tld}:
|
||||
get:
|
||||
summary: Get Namespace Price
|
||||
description: Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
|
||||
description: Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_namespace_price
|
||||
@@ -2229,7 +2248,7 @@ paths:
|
||||
/v2/prices/names/{name}:
|
||||
get:
|
||||
summary: Get Name Price
|
||||
description: Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
|
||||
description: Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_name_price
|
||||
@@ -2254,7 +2273,7 @@ paths:
|
||||
/v1/namespaces:
|
||||
get:
|
||||
summary: Get All Namespaces
|
||||
description: Fetch a list of all namespaces known to the node.
|
||||
description: Retrieves a list of all namespaces known to the node.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_all_namespaces
|
||||
@@ -2271,7 +2290,7 @@ paths:
|
||||
/v1/namespaces/{tld}/names:
|
||||
get:
|
||||
summary: Get Namespace Names
|
||||
description: Fetch a list of names from the namespace.
|
||||
description: Retrieves a list of names within a given namespace.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_namespace_names
|
||||
@@ -2319,7 +2338,7 @@ paths:
|
||||
/v1/names:
|
||||
get:
|
||||
summary: Get All Names
|
||||
description: Fetch a list of all names known to the node.
|
||||
description: Retrieves a list of all names known to the node.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_all_names
|
||||
@@ -2352,6 +2371,7 @@ paths:
|
||||
/v1/names/{name}:
|
||||
get:
|
||||
summary: Get Name Details
|
||||
description: Retrieves details of a given name including the address, status and last transaction id.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_name_info
|
||||
@@ -2392,7 +2412,7 @@ paths:
|
||||
/v1/names/{name}/history:
|
||||
get:
|
||||
summary: Get Name History
|
||||
description: Get a history of all blockchain records of a registered name.
|
||||
description: Retrieves a history of all blockchain records of a registered name.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_name_history
|
||||
@@ -2439,8 +2459,8 @@ paths:
|
||||
|
||||
/v1/names/{name}/zonefile:
|
||||
get:
|
||||
summary: Fetch Zone File
|
||||
description: Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
|
||||
summary: Get Zone File
|
||||
description: Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
|
||||
tags:
|
||||
- Names
|
||||
operationId: fetch_zone_file
|
||||
@@ -2481,7 +2501,7 @@ paths:
|
||||
/v1/names/{name}/zonefile/{zoneFileHash}:
|
||||
get:
|
||||
summary: Get Historical Zone File
|
||||
description: Fetches the historical zonefile specified by the username and zone hash.
|
||||
description: Retrieves the historical zonefile specified by the username and zone hash.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_historical_zone_file
|
||||
@@ -2569,7 +2589,7 @@ paths:
|
||||
/v1/subdomains:
|
||||
get:
|
||||
summary: Get All Subdomains
|
||||
description: Fetch a list of all subdomains known to the node.
|
||||
description: Retrieves a list of all subdomains known to the node.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_all_subdomains
|
||||
@@ -2602,7 +2622,7 @@ paths:
|
||||
/v1/subdomains/{txid}:
|
||||
get:
|
||||
summary: Get Subdomain at Transaction
|
||||
description: Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
|
||||
description: Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
|
||||
tags:
|
||||
- Names
|
||||
operationId: get_subdomain_at_transaction
|
||||
@@ -2635,8 +2655,8 @@ paths:
|
||||
/extended/v1/tx/block/{block_hash}:
|
||||
get:
|
||||
operationId: get_transactions_by_block_hash
|
||||
summary: Transactions in a block
|
||||
description: Get all transactions in block
|
||||
summary: Transactions by block hash
|
||||
description: Retrieves a list of all transactions within a block for a given block hash.
|
||||
tags:
|
||||
- Transactions
|
||||
parameters:
|
||||
@@ -2671,8 +2691,8 @@ paths:
|
||||
/extended/v1/tx/block_height/{height}:
|
||||
get:
|
||||
operationId: get_transactions_by_block_height
|
||||
summary: Transactions in a block
|
||||
description: Get all transactions in block by height
|
||||
summary: Transactions by block height
|
||||
description: Retrieves all transactions within a block at a given height
|
||||
tags:
|
||||
- Transactions
|
||||
parameters:
|
||||
@@ -2715,7 +2735,7 @@ paths:
|
||||
get:
|
||||
operationId: get_address_mempool_transactions
|
||||
summary: Transactions for address
|
||||
description: Get all transactions for address in mempool
|
||||
description: Retrieves all transactions for a given address that are currently in mempool
|
||||
tags:
|
||||
- Transactions
|
||||
parameters:
|
||||
@@ -2758,7 +2778,7 @@ paths:
|
||||
get:
|
||||
operationId: get_ft_metadata_list
|
||||
summary: Fungible tokens metadata list
|
||||
description: Get list of fungible tokens metadata
|
||||
description: Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
|
||||
tags:
|
||||
- Fungible Tokens
|
||||
parameters:
|
||||
@@ -2788,7 +2808,7 @@ paths:
|
||||
get:
|
||||
operationId: get_nft_metadata_list
|
||||
summary: Non fungible tokens metadata list
|
||||
description: Get list of non fungible tokens metadata
|
||||
description: Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
|
||||
tags:
|
||||
- Non-Fungible Tokens
|
||||
parameters:
|
||||
@@ -2818,7 +2838,7 @@ paths:
|
||||
get:
|
||||
operationId: get_contract_nft_metadata
|
||||
summary: Non fungible tokens metadata for contract id
|
||||
description: Get non fungible tokens metadata for given contract id
|
||||
description: Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
|
||||
tags:
|
||||
- Non-Fungible Tokens
|
||||
parameters:
|
||||
@@ -2842,7 +2862,7 @@ paths:
|
||||
get:
|
||||
operationId: get_contract_ft_metadata
|
||||
summary: Fungible tokens metadata for contract id
|
||||
description: Get fungible tokens metadata for given contract id
|
||||
description: Retrieves the metadata for fungible tokens for a given contract id
|
||||
tags:
|
||||
- Fungible Tokens
|
||||
parameters:
|
||||
@@ -2866,7 +2886,7 @@ paths:
|
||||
post:
|
||||
operationId: fetch_fee_rate
|
||||
summary: fetch fee rate
|
||||
description: Fetch fee rate information.
|
||||
description: Retrieves estimated fee rate.
|
||||
tags:
|
||||
- Fees
|
||||
responses:
|
||||
|
||||
Reference in New Issue
Block a user