BlockFrostAPI

Class: BlockFrostAPI

Constructors

constructor

• new BlockFrostAPI(options?)

Parameters

Name	Type
`options?`	`Options`

Defined in

src/BlockFrostAPI.ts:164

Properties

accounts

• accounts: (this: BlockFrostAPI, stakeAddress: string) => Promise<components["schemas"]["account_content"]> = accounts

Type declaration

▸ (this, stakeAddress): Promise<components["schemas"]["account_content"]>

Obtains information about a specific stake account.

See

API docs for Specific account address

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address

Returns

Promise<components["schemas"]["account_content"]>

Information about a specific stake account.

Defined in

src/BlockFrostAPI.ts:199

accountsAddresses

• accountsAddresses: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_addresses_content"]> = accountsAddresses

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_addresses_content"]>

Obtains information about the addresses of a specific account.

See

API docs for Account associated addresses

Remarks

Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_addresses_content"]>

Information about the addresses of a specific account.

Defined in

src/BlockFrostAPI.ts:212

accountsAddressesAll

• accountsAddressesAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_addresses_content"]> = accountsAddressesAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_addresses_content"]>

Obtains information about all addresses of a specific account.

See

API docs for Account associated addresses

Remarks

Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_addresses_content"]>

Information about the addresses of a specific account.

Defined in

src/BlockFrostAPI.ts:213

accountsAddressesAssets

• accountsAddressesAssets: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_addresses_assets"]> = accountsAddressesAssets

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_addresses_assets"]>

Obtains information about assets associated with addresses of a specific account.

See

API docs for Assets associated with the account addresses

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_addresses_assets"]>

Assets associated with the account addresses

Defined in

src/BlockFrostAPI.ts:214

accountsAddressesAssetsAll

• accountsAddressesAssetsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_addresses_assets"]> = accountsAddressesAssetsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_addresses_assets"]>

Obtains information about all assets associated with addresses of a specific account.

See

API docs for Assets associated with the account addresses

Remarks

Variant of accountsAddressesAssets method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_addresses_assets"]>

Assets associated with the account addresses

Defined in

src/BlockFrostAPI.ts:215

accountsAddressesTotal

• accountsAddressesTotal: (this: BlockFrostAPI, stakeAddress: string) => Promise<components["schemas"]["account_addresses_total"]> = accountsAddressesTotal

Type declaration

▸ (this, stakeAddress): Promise<components["schemas"]["account_addresses_total"]>

Obtains summed details about all addresses associated with a given account.

See

API docs for Detailed information about account associated addresses

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address

Returns

Promise<components["schemas"]["account_addresses_total"]>

Summed details of the addresses associated with a given account

Defined in

src/BlockFrostAPI.ts:216

accountsDelegations

• accountsDelegations: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_delegation_content"]> = accountsDelegations

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_delegation_content"]>

Obtains information about the delegation of a specific account.

See

API docs for Account delegation history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_delegation_content"]>

Information about the delegation of a specific account.

Defined in

src/BlockFrostAPI.ts:200

accountsDelegationsAll

• accountsDelegationsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_delegation_content"]> = accountsDelegationsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_delegation_content"]>

Obtains information about all delegations of a specific account.

See

API docs for Account delegation history

Remarks

Variant of accountsDelegations method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_delegation_content"]>

Information about the delegation of a specific account.

Defined in

src/BlockFrostAPI.ts:201

accountsHistory

• accountsHistory: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_history_content"]> = accountsHistory

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_history_content"]>

Obtains information about the history of a specific account.

See

API docs for Account history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_history_content"]>

Information about the history of a specific account.

Defined in

src/BlockFrostAPI.ts:206

accountsHistoryAll

• accountsHistoryAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_history_content"]> = accountsHistoryAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_history_content"]>

Obtains information about the whole history of a specific account.

See

API docs for Account history

Remarks

Variant of accountsHistory method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_history_content"]>

Information about the history of a specific account.

Defined in

src/BlockFrostAPI.ts:207

accountsMirs

• accountsMirs: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_mir_content"]> = accountsMirs

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_mir_content"]>

Obtains information about the MIRs of a specific account.

See

API docs for Account MIR history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_mir_content"]>

Information about the MIRs of a specific account.

Defined in

src/BlockFrostAPI.ts:210

accountsMirsAll

• accountsMirsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_mir_content"]> = accountsMirsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_mir_content"]>

Obtains information about the MIRs of a specific account.

See

API docs for Account MIR history

Remarks

Variant of accountsMirs method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_mir_content"]>

Information about the MIRs of a specific account.

Defined in

src/BlockFrostAPI.ts:211

accountsRegistrations

• accountsRegistrations: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_registration_content"]> = accountsRegistrations

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_registration_content"]>

Obtains information about the registrations and deregistrations of a specific account.

See

API docs for Account registration history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_registration_content"]>

Information about the registrations and deregistrations of a specific account.

Defined in

src/BlockFrostAPI.ts:202

accountsRegistrationsAll

• accountsRegistrationsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_registration_content"]> = accountsRegistrationsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_registration_content"]>

Obtains information about the registrations and deregistrations of a specific account.

See

API docs for Account registration history

Remarks

Variant of accountsRegistrations method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_registration_content"]>

Information about the registrations and deregistrations of a specific account.

Defined in

src/BlockFrostAPI.ts:203

accountsRewards

• accountsRewards: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_reward_content"]> = accountsRewards

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_reward_content"]>

Obtains information about the reward history of a specific account.

See

API docs for Account reward history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_reward_content"]>

Information about the history of a specific account.

Defined in

src/BlockFrostAPI.ts:204

accountsRewardsAll

• accountsRewardsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_reward_content"]> = accountsRewardsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_reward_content"]>

Obtains information about the whole reward history of a specific account.

See

API docs for Account reward history

Remarks

Variant of accountsRewards method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_reward_content"]>

Information about the reward history of a specific account.

Defined in

src/BlockFrostAPI.ts:205

accountsWithdrawals

• accountsWithdrawals: (this: BlockFrostAPI, stakeAddress: string, pagination?: PaginationOptions) => Promise<components["schemas"]["account_withdrawal_content"]> = accountsWithdrawals

Type declaration

▸ (this, stakeAddress, pagination?): Promise<components["schemas"]["account_withdrawal_content"]>

Obtains information about the withdrawals of a specific account.

See

API docs for Account withdrawal history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["account_withdrawal_content"]>

Information about the withdrawals of a specific account.

Defined in

src/BlockFrostAPI.ts:208

accountsWithdrawalsAll

• accountsWithdrawalsAll: (this: BlockFrostAPI, stakeAddress: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["account_withdrawal_content"]> = accountsWithdrawalsAll

Type declaration

▸ (this, stakeAddress, allMethodOptions?): Promise<components["schemas"]["account_withdrawal_content"]>

Obtains information about all withdrawals of a specific account.

See

API docs for Account withdrawal history

Remarks

Variant of accountsWithdrawals method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`stakeAddress`	`string`	Bech32 stake address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["account_withdrawal_content"]>

Information about all withdrawals of a specific account.

Defined in

src/BlockFrostAPI.ts:209

addresses

• addresses: (this: BlockFrostAPI, address: string) => Promise<components["schemas"]["address_content"]> = addresses

Type declaration

▸ (this, address): Promise<components["schemas"]["address_content"]>

Obtains information about a specific address.

See

API docs for Specific address

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address

Returns

Promise<components["schemas"]["address_content"]>

Information about a specific stake account.

Defined in

src/BlockFrostAPI.ts:227

addressesExtended

• addressesExtended: (this: BlockFrostAPI, address: string) => Promise<components["schemas"]["address_content_extended"]> = addressesExtended

Type declaration

▸ (this, address): Promise<components["schemas"]["address_content_extended"]>

Obtains extended information about a specific address.

See

API docs for Extended information of a specific address

Remarks

Similar to addresses with the addition of has_nft_onchain_metadata and decimals fields in asset amounts.

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address

Returns

Promise<components["schemas"]["address_content_extended"]>

Extended information about a specific address

Defined in

src/BlockFrostAPI.ts:229

addressesTotal

• addressesTotal: (this: BlockFrostAPI, address: string) => Promise<components["schemas"]["address_content_total"]> = addressesTotal

Type declaration

▸ (this, address): Promise<components["schemas"]["address_content_total"]>

Obtains aggregated details about transactions for a specific address (received assets, sent assets, number of transactions).

See

API docs for Address details

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address

Returns

Promise<components["schemas"]["address_content_total"]>

Aggregated details about an address (received assets, sent assets, number of transactions)

Defined in

src/BlockFrostAPI.ts:228

addressesTransactions

• addressesTransactions: (this: BlockFrostAPI, address: string, pagination?: PaginationOptions, additionalOptions?: AdditionalEndpointOptions) => Promise<components["schemas"]["address_transactions_content"]> = addressesTransactions

Type declaration

▸ (this, address, pagination?, additionalOptions?): Promise<components["schemas"]["address_transactions_content"]>

Obtains transactions on the address.

See

API docs for Address transactions

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`pagination?`	`PaginationOptions`	Optional, Pagination options
`additionalOptions?`	`AdditionalEndpointOptions`	Optional, Additional options such as cursor pagination

Returns

Promise<components["schemas"]["address_transactions_content"]>

Extended information about a specific address

Defined in

src/BlockFrostAPI.ts:230

addressesTransactionsAll

• addressesTransactionsAll: (this: BlockFrostAPI, address: string, allMethodOptions?: AllMethodOptions, additionalOptions?: AdditionalEndpointOptions) => Promise<components["schemas"]["address_transactions_content"]> = addressesTransactionsAll

Type declaration

▸ (this, address, allMethodOptions?, additionalOptions?): Promise<components["schemas"]["address_transactions_content"]>

Obtains all transactions on the address.

See

API docs for Address transactions

Remarks

Variant of addressesTransactions method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching
`additionalOptions?`	`AdditionalEndpointOptions`	Optional, Additional options such as cursor pagination

Returns

Promise<components["schemas"]["address_transactions_content"]>

Extended information about a specific address

Defined in

src/BlockFrostAPI.ts:231

addressesUtxos

• addressesUtxos: (this: BlockFrostAPI, address: string, pagination?: PaginationOptions) => Promise<components["schemas"]["address_utxo_content"]> = addressesUtxos

Type declaration

▸ (this, address, pagination?): Promise<components["schemas"]["address_utxo_content"]>

Obtains UTXOs of the address

See

API docs for Address UTXOs

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["address_utxo_content"]>

UTXOs of the address

Defined in

src/BlockFrostAPI.ts:232

addressesUtxosAll

• addressesUtxosAll: (this: BlockFrostAPI, address: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["address_utxo_content"]> = addressesUtxosAll

Type declaration

▸ (this, address, allMethodOptions?): Promise<components["schemas"]["address_utxo_content"]>

Obtains all UTXOs of the address

See

API docs for Address UTXOs

Remarks

Variant of addressesUtxos method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["address_utxo_content"]>

UTXOs of the address

Defined in

src/BlockFrostAPI.ts:233

addressesUtxosAsset

• addressesUtxosAsset: (this: BlockFrostAPI, address: string, asset: string, pagination?: PaginationOptions) => Promise<components["schemas"]["address_utxo_content"]> = addressesUtxosAsset

Type declaration

▸ (this, address, asset, pagination?): Promise<components["schemas"]["address_utxo_content"]>

Obtains address's UTXOs containing a given asset (paginated)

See

API docs for Address UTXOs of a given asset

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["address_utxo_content"]>

List of the address's utxos containing a given asset

Defined in

src/BlockFrostAPI.ts:234

addressesUtxosAssetAll

• addressesUtxosAssetAll: (this: BlockFrostAPI, address: string, asset: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["address_utxo_content"]> = addressesUtxosAssetAll

Type declaration

▸ (this, address, asset, allMethodOptions?): Promise<components["schemas"]["address_utxo_content"]>

Obtains all address's UTXOs containing a given asset

See

API docs for Address UTXOs of a given asset

Remarks

Variant of addressesUtxosAsset method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`address`	`string`	Bech32 address
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["address_utxo_content"]>

List of the address's utxos containing a given asset

Defined in

src/BlockFrostAPI.ts:235

apiUrl

• apiUrl: string

Defined in

src/BlockFrostAPI.ts:152

assets

• assets: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["assets"]> = assets

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["assets"]>

Obtains list of assets.

See

API docs for Assets

Remarks

If an asset is completely burned, it will stay on the list with quantity 0 (order of assets is immutable).

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["assets"]>

List of assets

Defined in

src/BlockFrostAPI.ts:218

assetsAddresses

• assetsAddresses: (this: BlockFrostAPI, asset: string, pagination?: PaginationOptions) => Promise<components["schemas"]["asset_addresses"]> = assetsAddresses

Type declaration

▸ (this, asset, pagination?): Promise<components["schemas"]["asset_addresses"]>

Obtains list of a addresses containing a specific asset.

See

API docs for Asset addresses

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["asset_addresses"]>

List of a addresses containing a specific asset.

Defined in

src/BlockFrostAPI.ts:223

assetsById

• assetsById: (this: BlockFrostAPI, asset: string) => Promise<components["schemas"]["asset"]> = assetsById

Type declaration

▸ (this, asset): Promise<components["schemas"]["asset"]>

Obtains information about a specific asset.

See

API docs for Asset

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name

Returns

Promise<components["schemas"]["asset"]>

Information about a specific asset.

Defined in

src/BlockFrostAPI.ts:219

assetsHistory

• assetsHistory: (this: BlockFrostAPI, asset: string, pagination?: PaginationOptions) => Promise<components["schemas"]["asset_history"]> = assetsHistory

Type declaration

▸ (this, asset, pagination?): Promise<components["schemas"]["asset_history"]>

Obtains history of a specific asset.

See

API docs for Asset history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["asset_history"]>

History of a specific asset.

Defined in

src/BlockFrostAPI.ts:220

assetsHistoryAll

• assetsHistoryAll: (this: BlockFrostAPI, asset: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["asset_history"]> = assetsHistoryAll

Type declaration

▸ (this, asset, allMethodOptions?): Promise<components["schemas"]["asset_history"]>

Obtains whole history of a specific asset.

See

API docs for Asset history

Remarks

Variant of assetsHistory method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["asset_history"]>

Whole history of a specific asset.

Defined in

src/BlockFrostAPI.ts:221

assetsPolicyById

• assetsPolicyById: (this: BlockFrostAPI, policyId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["asset_policy"]> = assetsPolicyById

Type declaration

▸ (this, policyId, pagination?): Promise<components["schemas"]["asset_policy"]>

Obtains list of assets minted under a specific policy.

See

API docs for Assets of a specific policy

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`policyId`	`string`	Specific policy ID
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["asset_policy"]>

List of assets minted under a specific policy.

Defined in

src/BlockFrostAPI.ts:224

assetsPolicyByIdAll

• assetsPolicyByIdAll: (this: BlockFrostAPI, policyId: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["asset_policy"]> = assetsPolicyByIdAll

Type declaration

▸ (this, policyId, allMethodOptions?): Promise<components["schemas"]["asset_policy"]>

Obtains list of all assets minted under a specific policy.

See

API docs for Assets of a specific policy

Remarks

Variant of assetsPolicyById method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`policyId`	`string`	Specific policy ID
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["asset_policy"]>

List of asset minted under a specific policy.

Defined in

src/BlockFrostAPI.ts:225

assetsTransactions

• assetsTransactions: (this: BlockFrostAPI, asset: string, pagination?: PaginationOptions) => Promise<components["schemas"]["asset_transactions"]> = assetsTransactions

Type declaration

▸ (this, asset, pagination?): Promise<components["schemas"]["asset_transactions"]>

Lists of transactions of a specific asset.

See

API docs for Asset transactions

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`asset`	`string`	Concatenation of the policy ID and hex-encoded asset name
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["asset_transactions"]>

List of a specific asset transactions.

Defined in

src/BlockFrostAPI.ts:222

blocks

• blocks: (this: BlockFrostAPI, hashOrNumber: HashOrNumber) => Promise<components["schemas"]["block_content"]> = blocks

Type declaration

▸ (this, hashOrNumber): Promise<components["schemas"]["block_content"]>

Obtains a specific block.

See

API docs for Latest block

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`HashOrNumber`	Hash or number of the requested block

Returns

Promise<components["schemas"]["block_content"]>

Specific block

Defined in

src/BlockFrostAPI.ts:237

blocksAddresses

• blocksAddresses: (this: BlockFrostAPI, hashOrNumber: HashOrNumber, pagination?: Omit<PaginationOptions, "order">) => Promise<components["schemas"]["block_content_addresses"]> = blocksAddresses

Type declaration

▸ (this, hashOrNumber, pagination?): Promise<components["schemas"]["block_content_addresses"]>

Obtains list of addresses affected in the specified block with additional information.

Remarks

Sorted by the bech32 address, in ascending order.

See

API docs for Addresses affected in a specific block

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`HashOrNumber`	Hash or number of the requested block
`pagination?`	`Omit`<`PaginationOptions`, `"order"`>	Optional, Pagination options

Returns

Promise<components["schemas"]["block_content_addresses"]>

List of addresses affected in the specified block

Defined in

src/BlockFrostAPI.ts:245

blocksAddressesAll

• blocksAddressesAll: (this: BlockFrostAPI, hashOrNumber: string | number, allMethodOptions?: Omit<AllMethodOptions, "order">) => Promise<components["schemas"]["block_content_addresses"]> = blocksAddressesAll

Type declaration

▸ (this, hashOrNumber, allMethodOptions?): Promise<components["schemas"]["block_content_addresses"]>

Obtains list of addresses affected in the specified block with additional information.

See

API docs for Addresses affected in a specific block

Remarks

Sorted by the bech32 address, in ascending order.

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`string` \| `number`	Hash or number of the requested block
`allMethodOptions?`	`Omit`<`AllMethodOptions`, `"order"`>	Optional, Options for request batching

Returns

Promise<components["schemas"]["block_content_addresses"]>

List of addresses affected in the specified block

Defined in

src/BlockFrostAPI.ts:246

blocksLatest

• blocksLatest: (this: BlockFrostAPI) => Promise<components["schemas"]["block_content"]> = blocksLatest

Type declaration

▸ (this): Promise<components["schemas"]["block_content"]>

Obtains the specific block available to the backends, also known as the tip of the blockchain.

See

API docs for Latest block

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["block_content"]>

latest block

Defined in

src/BlockFrostAPI.ts:238

blocksLatestTxs

• blocksLatestTxs: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["block_content_txs"]> = blocksLatestTxs

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["block_content_txs"]>

Obtains transactions within the latest block.

See

API docs for Latest block transactions

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["block_content_txs"]>

transactions within the latest block

Defined in

src/BlockFrostAPI.ts:239

blocksLatestTxsAll

• blocksLatestTxsAll: (this: BlockFrostAPI, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["block_content_txs"]> = blocksLatestTxsAll

Type declaration

▸ (this, allMethodOptions?): Promise<components["schemas"]["block_content_txs"]>

Obtains all transactions within the latest block.

See

API docs for Latest block transactions

Remarks

Variant of blocksLatestTxs method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["block_content_txs"]>

transactions within the latest block

Defined in

src/BlockFrostAPI.ts:240

blocksNext

• blocksNext: (this: BlockFrostAPI, hashOrNumber: HashOrNumber, pagination?: Omit<PaginationOptions, "order">) => Promise<components["schemas"]["block_content_array"]> = blocksNext

Type declaration

▸ (this, hashOrNumber, pagination?): Promise<components["schemas"]["block_content_array"]>

Obtains list of blocks following a specific block.

See

API docs for Listing of next blocks

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`HashOrNumber`	Hash or number of the requested block
`pagination?`	`Omit`<`PaginationOptions`, `"order"`>	Optional, Pagination options

Returns

Promise<components["schemas"]["block_content_array"]>

List of blocks following a specific block

Defined in

src/BlockFrostAPI.ts:241

blocksPrevious

• blocksPrevious: (this: BlockFrostAPI, hashOrNumber: HashOrNumber, pagination?: Omit<PaginationOptions, "order">) => Promise<components["schemas"]["block_content_array"]> = blocksPrevious

Type declaration

▸ (this, hashOrNumber, pagination?): Promise<components["schemas"]["block_content_array"]>

Obtains list of blocks preceding a specific block.

See

API docs for Listing of previous blocks

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`HashOrNumber`	Hash or number of the requested block
`pagination?`	`Omit`<`PaginationOptions`, `"order"`>	Optional, Pagination options

Returns

Promise<components["schemas"]["block_content_array"]>

List of blocks preceding a specific block

Defined in

src/BlockFrostAPI.ts:242

blocksTxs

• blocksTxs: (this: BlockFrostAPI, hashOrNumber: HashOrNumber, pagination?: PaginationOptions) => Promise<components["schemas"]["block_content_txs"]> = blocksTxs

Type declaration

▸ (this, hashOrNumber, pagination?): Promise<components["schemas"]["block_content_txs"]>

Obtains transactions within the specific block.

See

API docs for Block transactions

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`HashOrNumber`	Hash or number of the requested block
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["block_content_txs"]>

Transactions within the specific block

Defined in

src/BlockFrostAPI.ts:243

blocksTxsAll

• blocksTxsAll: (this: BlockFrostAPI, hashOrNumber: string | number, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["block_content_txs"]> = blocksTxsAll

Type declaration

▸ (this, hashOrNumber, allMethodOptions?): Promise<components["schemas"]["block_content_txs"]>

Obtains all transactions within the specific block.

See

API docs for Block transactions

Remarks

Variant of blocksTxs method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hashOrNumber`	`string` \| `number`	Hash or number of the requested block
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["block_content_txs"]>

All transactions within the specific block

Defined in

src/BlockFrostAPI.ts:244

epochs

• epochs: (this: BlockFrostAPI, number: number) => Promise<components["schemas"]["epoch_content"]> = epochs

Type declaration

▸ (this, number): Promise<components["schemas"]["epoch_content"]>

Obtains information about a specific epoch.

See

API docs for Specific epoch

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch

Returns

Promise<components["schemas"]["epoch_content"]>

Information about a specific epoch.

Defined in

src/BlockFrostAPI.ts:248

epochsBlocks

• epochsBlocks: (this: BlockFrostAPI, number: number, pagination?: PaginationOptions) => Promise<components["schemas"]["epoch_block_content"]> = epochsBlocks

Type declaration

▸ (this, number, pagination?): Promise<components["schemas"]["epoch_block_content"]>

Obtains the blocks minted for the epoch specified.

See

API docs for Block distribution

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_block_content"]>

Blocks minted for the epoch specified

Defined in

src/BlockFrostAPI.ts:249

epochsBlocksAll

• epochsBlocksAll: (this: BlockFrostAPI, number: number, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["epoch_block_content"]> = epochsBlocksAll

Type declaration

▸ (this, number, allMethodOptions?): Promise<components["schemas"]["epoch_block_content"]>

Obtains the blocks minted for the epoch specified.

See

API docs for Block distribution

Remarks

Variant of epochsBlocks method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["epoch_block_content"]>

Blocks minted for the epoch specified

Defined in

src/BlockFrostAPI.ts:250

epochsBlocksByPoolId

• epochsBlocksByPoolId: (this: BlockFrostAPI, number: number, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["epoch_block_content"]> = epochsBlocksByPoolId

Type declaration

▸ (this, number, poolId, pagination?): Promise<components["schemas"]["epoch_block_content"]>

Obtains the blocks minted for the epoch specified by stake pool.

See

API docs for Block distribution by pool

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`poolId`	`string`	Stake pool ID to filter
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_block_content"]>

Blocks minted for the epoch specified by stake pool

Defined in

src/BlockFrostAPI.ts:251

epochsBlocksByPoolIdAll

• epochsBlocksByPoolIdAll: (this: BlockFrostAPI, number: number, poolId: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["epoch_block_content"]> = epochsBlocksByPoolIdAll

Type declaration

▸ (this, number, poolId, allMethodOptions?): Promise<components["schemas"]["epoch_block_content"]>

Obtains the blocks minted for the epoch specified by stake pool.

See

API docs for Block distribution by pool

Remarks

Variant of epochsBlocksByPoolId method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`poolId`	`string`	Stake pool ID to filter
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["epoch_block_content"]>

Blocks minted for the epoch specified by stake pool

Defined in

src/BlockFrostAPI.ts:252

epochsLatest

• epochsLatest: (this: BlockFrostAPI) => Promise<components["schemas"]["epoch_content"]> = epochsLatest

Type declaration

▸ (this): Promise<components["schemas"]["epoch_content"]>

Obtains the information about the latest, therefore current, epoch.

See

API docs for Latest epoch

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["epoch_content"]>

Information about the current epoch.

Defined in

src/BlockFrostAPI.ts:253

epochsLatestParameters

• epochsLatestParameters: (this: BlockFrostAPI) => Promise<components["schemas"]["epoch_param_content"]> = epochsLatestParameters

Type declaration

▸ (this): Promise<components["schemas"]["epoch_param_content"]>

Obtains the protocol parameters for the latest epoch.

See

API docs for Latest epoch protocol parameters

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["epoch_param_content"]>

Protocol parameters for the latest epoch

Defined in

src/BlockFrostAPI.ts:256

epochsNext

• epochsNext: (this: BlockFrostAPI, number: number, pagination?: Omit<PaginationOptions, "order">) => Promise<components["schemas"]["epoch_content_array"]> = epochsNext

Type declaration

▸ (this, number, pagination?): Promise<components["schemas"]["epoch_content_array"]>

Obtains a list of epochs following a specific epoch.

See

API docs for Listing of next epochs

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`pagination?`	`Omit`<`PaginationOptions`, `"order"`>	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_content_array"]>

List of epochs following a specific epoch.

Defined in

src/BlockFrostAPI.ts:254

epochsParameters

• epochsParameters: (this: BlockFrostAPI, number: number) => Promise<components["schemas"]["epoch_param_content"]> = epochsParameters

Type declaration

▸ (this, number): Promise<components["schemas"]["epoch_param_content"]>

Obtains the protocol parameters for the epoch specified.

See

API docs for Protocol Parameters

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch

Returns

Promise<components["schemas"]["epoch_param_content"]>

Protocol parameters for the epoch specified

Defined in

src/BlockFrostAPI.ts:255

epochsPrevious

• epochsPrevious: (this: BlockFrostAPI, number: number, pagination?: Omit<PaginationOptions, "order">) => Promise<components["schemas"]["epoch_content_array"]> = epochsPrevious

Type declaration

▸ (this, number, pagination?): Promise<components["schemas"]["epoch_content_array"]>

Obtains a list of epochs preceding a specific epoch.

See

API docs for Listing of next epochs

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`pagination?`	`Omit`<`PaginationOptions`, `"order"`>	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_content_array"]>

List of epochs preceding a specific epoch.

Defined in

src/BlockFrostAPI.ts:257

epochsStakes

• epochsStakes: (this: BlockFrostAPI, number: number, pagination?: PaginationOptions) => Promise<components["schemas"]["epoch_stake_content"]> = epochsStakes

Type declaration

▸ (this, number, pagination?): Promise<components["schemas"]["epoch_stake_content"]>

Obtains the active stake distribution for the specified epoch.

See

API docs for Stake distribution

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_stake_content"]>

Active stake distribution for the specified epoch

Defined in

src/BlockFrostAPI.ts:258

epochsStakesAll

• epochsStakesAll: (this: BlockFrostAPI, number: number, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["epoch_stake_content"]> = epochsStakesAll

Type declaration

▸ (this, number, allMethodOptions?): Promise<components["schemas"]["epoch_stake_content"]>

Obtains the whole active stake distribution for the specified epoch.

See

API docs for Stake distribution

Remarks

Variant of epochsStakes method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["epoch_stake_content"]>

Active stake distribution for the specified epoch

Defined in

src/BlockFrostAPI.ts:259

epochsStakesByPoolId

• epochsStakesByPoolId: (this: BlockFrostAPI, number: number, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["epoch_stake_pool_content"]> = epochsStakesByPoolId

Type declaration

▸ (this, number, poolId, pagination?): Promise<components["schemas"]["epoch_stake_pool_content"]>

Obtains the active stake distribution for the epoch specified by stake pool.

See

API docs for Stake distribution

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`poolId`	`string`	Stake pool ID to filter
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["epoch_stake_pool_content"]>

Active stake distribution for the epoch specified by stake pool

Defined in

src/BlockFrostAPI.ts:260

epochsStakesByPoolIdAll

• epochsStakesByPoolIdAll: (this: BlockFrostAPI, number: number, poolId: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["epoch_stake_pool_content"]> = epochsStakesByPoolIdAll

Type declaration

▸ (this, number, poolId, allMethodOptions?): Promise<components["schemas"]["epoch_stake_pool_content"]>

Obtains the whole active stake distribution for the epoch specified by stake pool.

See

API docs for Stake distribution

Remarks

Variant of epochsStakesByPoolId method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`number`	`number`	Number of the epoch
`poolId`	`string`	Stake pool ID to filter
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["epoch_stake_pool_content"]>

Active stake distribution for the epoch specified by stake pool

Defined in

src/BlockFrostAPI.ts:261

genesis

• genesis: (this: BlockFrostAPI) => Promise<components["schemas"]["genesis_content"]> = genesis

Type declaration

▸ (this): Promise<components["schemas"]["genesis_content"]>

Obtains the information about blockchain genesis.

See

API docs for Blockchain genesis

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["genesis_content"]>

Genesis parameters

Defined in

src/BlockFrostAPI.ts:265

health

• health: (this: BlockFrostAPI) => Promise<{ is_healthy: boolean }> = health

Type declaration

▸ (this): Promise<{ is_healthy: boolean }>

Obtains backend status

Remarks

Your application should handle situations when backend for the given chain is unavailable.

See

API docs for Backend health status

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<{ is_healthy: boolean }>

Backend status in the format {is_healthy: boolean}

Defined in

src/BlockFrostAPI.ts:263

healthClock

• healthClock: (this: BlockFrostAPI) => Promise<{ server_time: number }> = healthClock

Type declaration

▸ (this): Promise<{ server_time: number }>

Obtains the current UNIX time. Your application might use this to verify if the client clock is not out of sync.

See

API docs for Current backend time

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<{ server_time: number }>

Unix time in the format {server_time: number}

Defined in

src/BlockFrostAPI.ts:264

mempool

• mempool: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["mempool_content"]> = mempool

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["mempool_content"]>

Obtains transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block.

Remarks

Returns only transactions submitted via Blockfrost.io.

See

API docs for Mempool

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["mempool_content"]>

List of transactions in Blockfrost Mempool

Defined in

src/BlockFrostAPI.ts:267

mempoolAll

• mempoolAll: (this: BlockFrostAPI, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["mempool_content"]> = mempoolAll

Type declaration

▸ (this, allMethodOptions?): Promise<components["schemas"]["mempool_content"]>

Obtains all transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block.

Remarks

Returns only transactions submitted via Blockfrost.io.

See

API docs for Mempool

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["mempool_content"]>

List of transactions in Blockfrost Mempool

Defined in

src/BlockFrostAPI.ts:268

mempoolTx

• mempoolTx: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["mempool_tx_content"]> = mempoolTx

Type declaration

▸ (this, hash): Promise<components["schemas"]["mempool_tx_content"]>

Obtains mempool transaction

See

API docs for Mempool transaction

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Hash of the requested transaction

Returns

Promise<components["schemas"]["mempool_tx_content"]>

Specific mempool transaction

Defined in

src/BlockFrostAPI.ts:269

metadataTxsLabel

• metadataTxsLabel: (this: BlockFrostAPI, label: string | number, pagination?: PaginationOptions) => Promise<components["schemas"]["tx_metadata_label_json"]> = metadataTxsLabel

Type declaration

▸ (this, label, pagination?): Promise<components["schemas"]["tx_metadata_label_json"]>

Obtains transaction metadata for a specific label in JSON format.

See

API docs for Transaction metadata content in JSON

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`label`	`string` \| `number`	Metadata label
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["tx_metadata_label_json"]>

List of transaction metadata for the specific label

Defined in

src/BlockFrostAPI.ts:271

metadataTxsLabelCbor

• metadataTxsLabelCbor: (this: BlockFrostAPI, label: string, pagination?: PaginationOptions) => Promise<components["schemas"]["tx_metadata_label_cbor"]> = metadataTxsLabelCbor

Type declaration

▸ (this, label, pagination?): Promise<components["schemas"]["tx_metadata_label_cbor"]>

Obtains transaction metadata for a specific label in CBOR format.

See

API docs for Transaction metadata content in CBOR

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`label`	`string`	Metadata label
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["tx_metadata_label_cbor"]>

List of transaction metadata for the specific label

Defined in

src/BlockFrostAPI.ts:272

metadataTxsLabels

• metadataTxsLabels: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["tx_metadata_labels"]> = metadataTxsLabels

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["tx_metadata_labels"]>

Obtains list of all used transaction metadata labels.

See

API docs for Transaction metadata labels

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["tx_metadata_labels"]>

List of all used transaction metadata labels

Defined in

src/BlockFrostAPI.ts:273

metrics

• metrics: (this: BlockFrostAPI) => Promise<components["schemas"]["metrics"]> = metrics

Type declaration

▸ (this): Promise<components["schemas"]["metrics"]>

Obtains history of your Blockfrost usage metrics in the past 30 days.

See

API docs for Blockfrost usage metrics

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["metrics"]>

Usage metrics for the last 30 days

Defined in

src/BlockFrostAPI.ts:275

metricsEndpoints

• metricsEndpoints: (this: BlockFrostAPI) => Promise<components["schemas"]["metrics"]> = metricsEndpoints

Type declaration

▸ (this): Promise<components["schemas"]["metrics"]>

Obtains history of your Blockfrost usage metrics, grouped per endpoint, in the past 30 days.

See

API docs for Blockfrost endpoint usage metrics

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["metrics"]>

Usage metrics for the last 30 days

Defined in

src/BlockFrostAPI.ts:276

network

• network: (this: BlockFrostAPI) => Promise<components["schemas"]["network"]> = network

Type declaration

▸ (this): Promise<components["schemas"]["network"]>

Obtains detailed network information.

See

API docs for Network information

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<components["schemas"]["network"]>

Detailed network information.

Defined in

src/BlockFrostAPI.ts:323

nutlinkAddress

• nutlinkAddress: (this: BlockFrostAPI, address: string) => Promise<components["schemas"]["nutlink_address"]> = nutlinkAddress

Type declaration

▸ (this, address): Promise<components["schemas"]["nutlink_address"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`address`	`string`

Returns

Promise<components["schemas"]["nutlink_address"]>

Defined in

src/BlockFrostAPI.ts:278

nutlinkAddressTicker

• nutlinkAddressTicker: (this: BlockFrostAPI, address: string, ticker: string, pagination?: PaginationOptions) => Promise<components["schemas"]["nutlink_address_ticker"]> = nutlinkAddressTicker

Type declaration

▸ (this, address, ticker, pagination?): Promise<components["schemas"]["nutlink_address_ticker"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`address`	`string`
`ticker`	`string`
`pagination?`	`PaginationOptions`

Returns

Promise<components["schemas"]["nutlink_address_ticker"]>

Defined in

src/BlockFrostAPI.ts:279

nutlinkAddressTickerAll

• nutlinkAddressTickerAll: (this: BlockFrostAPI, address: string, ticker: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["nutlink_address_ticker"]> = nutlinkAddressTickerAll

Type declaration

▸ (this, address, ticker, allMethodOptions?): Promise<components["schemas"]["nutlink_address_ticker"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`address`	`string`
`ticker`	`string`
`allMethodOptions?`	`AllMethodOptions`

Returns

Promise<components["schemas"]["nutlink_address_ticker"]>

Defined in

src/BlockFrostAPI.ts:282

nutlinkAddressTickers

• nutlinkAddressTickers: (this: BlockFrostAPI, address: string, pagination?: PaginationOptions) => Promise<components["schemas"]["nutlink_address_tickers"]> = nutlinkAddressTickers

Type declaration

▸ (this, address, pagination?): Promise<components["schemas"]["nutlink_address_tickers"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`address`	`string`
`pagination?`	`PaginationOptions`

Returns

Promise<components["schemas"]["nutlink_address_tickers"]>

Defined in

src/BlockFrostAPI.ts:280

nutlinkAddressTickersAll

• nutlinkAddressTickersAll: (this: BlockFrostAPI, address: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["nutlink_address_tickers"]> = nutlinkAddressTickersAll

Type declaration

▸ (this, address, allMethodOptions?): Promise<components["schemas"]["nutlink_address_tickers"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`address`	`string`
`allMethodOptions?`	`AllMethodOptions`

Returns

Promise<components["schemas"]["nutlink_address_tickers"]>

Defined in

src/BlockFrostAPI.ts:281

nutlinkTickers

• nutlinkTickers: (this: BlockFrostAPI, ticker: string, pagination?: PaginationOptions) => Promise<components["schemas"]["nutlink_tickers_ticker"]> = nutlinkTickers

Type declaration

▸ (this, ticker, pagination?): Promise<components["schemas"]["nutlink_tickers_ticker"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`ticker`	`string`
`pagination?`	`PaginationOptions`

Returns

Promise<components["schemas"]["nutlink_tickers_ticker"]>

Defined in

src/BlockFrostAPI.ts:283

nutlinkTickersAll

• nutlinkTickersAll: (this: BlockFrostAPI, ticker: string, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["nutlink_tickers_ticker"]> = nutlinkTickersAll

Type declaration

▸ (this, ticker, allMethodOptions?): Promise<components["schemas"]["nutlink_tickers_ticker"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`ticker`	`string`
`allMethodOptions?`	`AllMethodOptions`

Returns

Promise<components["schemas"]["nutlink_tickers_ticker"]>

Defined in

src/BlockFrostAPI.ts:284

poolMetadata

• poolMetadata: (this: BlockFrostAPI, poolId: string) => Promise<components["schemas"]["pool_metadata"]> = poolMetadata

Type declaration

▸ (this, poolId): Promise<components["schemas"]["pool_metadata"]>

Obtains stake pool registration metadata.

See

API docs for Stake pool metadata

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID

Returns

Promise<components["schemas"]["pool_metadata"]>

Stake pool registration metadata

Defined in

src/BlockFrostAPI.ts:288

pools

• pools: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_list"]> = pools

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["pool_list"]>

Obtains list of registered stake pools (paginated).

See

API docs for List of stake pools

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["pool_list"]>

List of registered stake pools.

Defined in

src/BlockFrostAPI.ts:286

poolsAll

• poolsAll: (this: BlockFrostAPI, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["pool_list"]> = poolsAll

Type declaration

▸ (this, allMethodOptions?): Promise<components["schemas"]["pool_list"]>

Obtains list of all registered stake pools.

See

API docs for List of stake pools

Remarks

Variant of pools method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["pool_list"]>

List of registered stake pools.

Defined in

src/BlockFrostAPI.ts:287

poolsById

• poolsById: (this: BlockFrostAPI, poolId: string) => Promise<components["schemas"]["pool"]> = poolsById

Type declaration

▸ (this, poolId): Promise<components["schemas"]["pool"]>

Obtains information of a specific stake pool.

See

API docs for Stake Pool

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID

Returns

Promise<components["schemas"]["pool"]>

Information of a specific stake pool.

Defined in

src/BlockFrostAPI.ts:289

poolsByIdBlocks

• poolsByIdBlocks: (this: BlockFrostAPI, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_blocks"]> = poolsByIdBlocks

Type declaration

▸ (this, poolId, pagination?): Promise<components["schemas"]["pool_blocks"]>

Obtains list of stake pool blocks.

See

API docs for Stake pool blocks

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["pool_blocks"]>

List of stake pool blocks

Defined in

src/BlockFrostAPI.ts:290

poolsByIdDelegators

• poolsByIdDelegators: (this: BlockFrostAPI, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_delegators"]> = poolsByIdDelegators

Type declaration

▸ (this, poolId, pagination?): Promise<components["schemas"]["pool_delegators"]>

Obtains current stake pool delegators.

See

API docs for Stake pool delegators

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID
`pagination?`	`PaginationOptions`	-

Returns

Promise<components["schemas"]["pool_delegators"]>

Current stake pool delegators

Defined in

src/BlockFrostAPI.ts:291

poolsByIdHistory

• poolsByIdHistory: (this: BlockFrostAPI, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_history"]> = poolsByIdHistory

Type declaration

▸ (this, poolId, pagination?): Promise<components["schemas"]["pool_history"]>

Obtains history of stake pool parameters over epochs (paginated).

See

API docs for Stake pool history

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["pool_history"]>

List of stake pool parameters per epoch

Defined in

src/BlockFrostAPI.ts:292

poolsByIdRelays

• poolsByIdRelays: (this: BlockFrostAPI, poolId: string) => Promise<components["schemas"]["pool_relays"]> = poolsByIdRelays

Type declaration

▸ (this, poolId): Promise<components["schemas"]["pool_relays"]>

Obtains stake pool relays.

See

API docs for Stake pool relays

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID

Returns

Promise<components["schemas"]["pool_relays"]>

Stake pool relays

Defined in

src/BlockFrostAPI.ts:293

poolsByIdUpdates

• poolsByIdUpdates: (this: BlockFrostAPI, poolId: string, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_updates"]> = poolsByIdUpdates

Type declaration

▸ (this, poolId, pagination?): Promise<components["schemas"]["pool_updates"]>

Obtains list of certificate updates to the stake pool.

See

API docs for Stake pool updates

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`poolId`	`string`	Pool ID
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["pool_updates"]>

List of certificate updates to the stake pool

Defined in

src/BlockFrostAPI.ts:294

poolsExtended

• poolsExtended: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_list_extended"]> = poolsExtended

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["pool_list_extended"]>

Obtains list of registered stake pools with additional information.

See

API docs for List of stake pools with additional information

Parameters

Name	Type
`this`	`BlockFrostAPI`
`pagination?`	`PaginationOptions`

Returns

Promise<components["schemas"]["pool_list_extended"]>

List of registered stake pools with additional information

Defined in

src/BlockFrostAPI.ts:297

poolsExtendedAll

• poolsExtendedAll: (this: BlockFrostAPI, allMethodOptions?: AllMethodOptions) => Promise<components["schemas"]["pool_list_extended"]> = poolsExtendedAll

Type declaration

▸ (this, allMethodOptions?): Promise<components["schemas"]["pool_list_extended"]>

Obtains list of registered stake pools with additional information.

See

API docs for List of stake pools with additional information

Remarks

Variant of poolsExtended method for fetching all pages with built-in requests batching

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`allMethodOptions?`	`AllMethodOptions`	Optional, Options for request batching

Returns

Promise<components["schemas"]["pool_list_extended"]>

List of registered stake pools with additional information

Defined in

src/BlockFrostAPI.ts:298

poolsRetired

• poolsRetired: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_list_retire"]> = poolsRetired

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["pool_list_retire"]>

Parameters

Name	Type
`this`	`BlockFrostAPI`
`pagination?`	`PaginationOptions`

Returns

Promise<components["schemas"]["pool_list_retire"]>

Defined in

src/BlockFrostAPI.ts:295

poolsRetiring

• poolsRetiring: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["pool_list_retire"]> = poolsRetiring

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["pool_list_retire"]>

Obtains list of stake pools retiring in the upcoming epochs (paginated).

See

API docs for List of retiring stake pools

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["pool_list_retire"]>

List of stake pools retiring in the upcoming epochs

Defined in

src/BlockFrostAPI.ts:296

root

• root: (this: BlockFrostAPI) => Promise<{ url: string ; version: string }> = root

Type declaration

▸ (this): Promise<{ url: string ; version: string }>

Obtains backend version number.

Parameters

Name	Type
`this`	`BlockFrostAPI`

Returns

Promise<{ url: string ; version: string }>

Backend version in a format { url: string; version: string }

Defined in

src/BlockFrostAPI.ts:300

scripts

• scripts: (this: BlockFrostAPI, pagination?: PaginationOptions) => Promise<components["schemas"]["scripts"]> = scripts

Type declaration

▸ (this, pagination?): Promise<components["schemas"]["scripts"]>

Obtains list of scripts (paginated).

See

API docs for Scripts

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`pagination?`	`PaginationOptions`	Optional, Pagination options

Returns

Promise<components["schemas"]["scripts"]>

List of scripts

Defined in

src/BlockFrostAPI.ts:302

scriptsByHash

• scriptsByHash: (this: BlockFrostAPI, scriptHash: string) => Promise<components["schemas"]["script"]> = scriptsByHash

Type declaration

▸ (this, scriptHash): Promise<components["schemas"]["script"]>

Obtains information about a specific script.

See

API docs for Script

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`scriptHash`	`string`	Hash of the script

Returns

Promise<components["schemas"]["script"]>

Information about a specific script

Defined in

src/BlockFrostAPI.ts:303

scriptsCbor

• scriptsCbor: (this: BlockFrostAPI, scriptHash: string) => Promise<components["schemas"]["script_cbor"]> = scriptsCbor

Type declaration

▸ (this, scriptHash): Promise<components["schemas"]["script_cbor"]>

Obtains CBOR representation of a plutus script.

See

API docs for Script CBOR

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`scriptHash`	`string`	Hash of the script

Returns

Promise<components["schemas"]["script_cbor"]>

CBOR representation of a plutus script

Defined in

src/BlockFrostAPI.ts:305

scriptsDatum

• scriptsDatum: (this: BlockFrostAPI, datumHash: string) => Promise<components["schemas"]["script_datum"]> = scriptsDatum

Type declaration

▸ (this, datumHash): Promise<components["schemas"]["script_datum"]>

Obtains JSON value of a datum by its hash.

See

API docs for Datum value

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`datumHash`	`string`	Hash of the datum

Returns

Promise<components["schemas"]["script_datum"]>

JSON value of a datum specified by its hash

Defined in

src/BlockFrostAPI.ts:306

scriptsDatumCbor

• scriptsDatumCbor: (this: BlockFrostAPI, datumHash: string) => Promise<components["schemas"]["script_datum_cbor"]> = scriptsDatumCbor

Type declaration

▸ (this, datumHash): Promise<components["schemas"]["script_datum_cbor"]>

Obtains CBOR serialized datum by its hash.

See

API docs for Datum CBOR value

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`datumHash`	`string`	Hash of the datum

Returns

Promise<components["schemas"]["script_datum_cbor"]>

JSON value of a datum specified by its hash

Defined in

src/BlockFrostAPI.ts:307

scriptsJson

• scriptsJson: (this: BlockFrostAPI, scriptHash: string) => Promise<components["schemas"]["script_json"]> = scriptsJson

Type declaration

▸ (this, scriptHash): Promise<components["schemas"]["script_json"]>

Obtains JSON representation of a timelock script.

See

API docs for Script JSON

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`scriptHash`	`string`	Hash of the script

Returns

Promise<components["schemas"]["script_json"]>

JSON representation of a timelock script

Defined in

src/BlockFrostAPI.ts:304

scriptsRedeemers

• scriptsRedeemers: (this: BlockFrostAPI, scriptHash: string) => Promise<components["schemas"]["script_redeemers"]> = scriptsRedeemers

Type declaration

▸ (this, scriptHash): Promise<components["schemas"]["script_redeemers"]>

Obtains list of redeemers of a specific script

See

API docs for Redeemers of a specific script

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`scriptHash`	`string`	Hash of the script

Returns

Promise<components["schemas"]["script_redeemers"]>

List of redeemers of a specific script

Defined in

src/BlockFrostAPI.ts:308

txSubmit

• txSubmit: (this: BlockFrostAPI, transaction: string | Uint8Array) => Promise<string> = txSubmit

Type declaration

▸ (this, transaction): Promise<string>

Submits a transaction to the network.

See

API docs for Transaction submit

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`transaction`	`string` \| `Uint8Array`	Transaction bytes as Uint8Array or hex-encoded string

Returns

Promise<string>

ID of the submitted transaction

Defined in

src/BlockFrostAPI.ts:321

txs

• txs: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content"]> = txs

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content"]>

Obtains a specific transaction

See

API docs for Transaction

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content"]>

Transaction

Defined in

src/BlockFrostAPI.ts:310

txsDelegations

• txsDelegations: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_delegations"]> = txsDelegations

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_delegations"]>

Obtains information about delegation certificates of a specific transaction.

See

API docs for Transaction stake addresses certificates

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_delegations"]>

List of delegation certificates within the transaction

Defined in

src/BlockFrostAPI.ts:312

txsMetadata

• txsMetadata: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_metadata"]> = txsMetadata

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_metadata"]>

Obtains transaction metadata in JSON format.

See

API docs for Transaction metadata

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_metadata"]>

Transaction metadata in JSON

Defined in

src/BlockFrostAPI.ts:319

txsMetadataCbor

• txsMetadataCbor: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_metadata_cbor"]> = txsMetadataCbor

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_metadata_cbor"]>

Obtains transaction metadata in CBOR format.

See

API docs for Transaction metadata in CBOR

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_metadata_cbor"]>

Transaction metadata in CBOR

Defined in

src/BlockFrostAPI.ts:311

txsMirs

• txsMirs: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_mirs"]> = txsMirs

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_mirs"]>

Obtains information about Move Instantaneous Rewards (MIRs) of a specific transaction.

See

API docs for Transaction MIRs

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_mirs"]>

List of Move Instantaneous Rewards (MIRs) within the transaction

Defined in

src/BlockFrostAPI.ts:318

txsPoolRetires

• txsPoolRetires: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_pool_retires"]> = txsPoolRetires

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_pool_retires"]>

Obtains information about stake pool retirements within a specific transaction.

See

API docs for Transaction stake pool retirement certificates

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_pool_retires"]>

List of stake pool retirement certificates

Defined in

src/BlockFrostAPI.ts:313

txsPoolUpdates

• txsPoolUpdates: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_pool_certs"]> = txsPoolUpdates

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_pool_certs"]>

Obtains information about stake pool registration and update certificates of a specific transaction.

See

API docs for Transaction stake pool registration and update certificates

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_pool_certs"]>

List of stake pool registration and update certificates within a specific transaction

Defined in

src/BlockFrostAPI.ts:314

txsRedeemers

• txsRedeemers: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_redeemers"]> = txsRedeemers

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_redeemers"]>

Obtains transaction redeemers.

See

API docs for Transaction redeemers

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_redeemers"]>

Transaction redeemers

Defined in

src/BlockFrostAPI.ts:320

txsStakes

• txsStakes: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_stake_addr"]> = txsStakes

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_stake_addr"]>

Obtains information about (de)registration of stake addresses within a transaction.

See

API docs for Transaction stake addresses certificates

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_stake_addr"]>

List of (de)registration certificates within the transaction

Defined in

src/BlockFrostAPI.ts:315

txsUtxos

• txsUtxos: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_utxo"]> = txsUtxos

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_utxo"]>

Obtains the inputs and outputs of the specific transaction.

See

API docs for Transaction UTXOs

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_utxo"]>

Transaction inputs and outputs

Defined in

src/BlockFrostAPI.ts:316

txsWithdrawals

• txsWithdrawals: (this: BlockFrostAPI, hash: string) => Promise<components["schemas"]["tx_content_withdrawals"]> = txsWithdrawals

Type declaration

▸ (this, hash): Promise<components["schemas"]["tx_content_withdrawals"]>

Obtains information about withdrawals within a specific transaction.

See

API docs for Transaction withdrawal

Parameters

Name	Type	Description
`this`	`BlockFrostAPI`	-
`hash`	`string`	Transaction hash

Returns

Promise<components["schemas"]["tx_content_withdrawals"]>

List of withdrawals within the transaction

Defined in

src/BlockFrostAPI.ts:317

@blockfrost/blockfrost-js

Home
Exports

BlockFrostAPI

Class: BlockFrostAPI

Table of contents

Constructors

Properties

Constructors

constructor

Parameters

Defined in

Properties

accounts

Type declaration

Parameters

Returns

Defined in

accountsAddresses

Type declaration

Parameters

Returns

Defined in

accountsAddressesAll

Type declaration

Parameters

Returns

Defined in

accountsAddressesAssets

Type declaration

Parameters

Returns

Defined in

accountsAddressesAssetsAll

Type declaration

Parameters

Returns

Defined in

accountsAddressesTotal

Type declaration

Parameters

Returns

Defined in

accountsDelegations

Type declaration

Parameters

Returns

Defined in

accountsDelegationsAll

Type declaration

Parameters

Returns

Defined in

accountsHistory

Type declaration

Parameters

Returns

Defined in

accountsHistoryAll

Type declaration

Parameters

Returns

Defined in

accountsMirs

Type declaration

Parameters

Returns

Defined in

accountsMirsAll

Type declaration

Parameters

Returns

Defined in

accountsRegistrations

Type declaration

Parameters

Returns

Defined in

accountsRegistrationsAll

Type declaration

Parameters

Returns

Defined in