Interface InfoApiInterface

InfoApi - interface

Export

Interface

InfoApiInterface

Hierarchy

InfoApiInterface

Implemented by

InfoApi

Index

Methods

getCoreApiInfo getCoreApiInfoRaw getNetworkBlockTimeByNetwork getNetworkBlockTimeByNetworkRaw getNetworkBlockTimes getNetworkBlockTimesRaw getPoxInfo getPoxInfoRaw getStatus getStatusRaw getStxSupply getStxSupplyCirculatingPlain getStxSupplyCirculatingPlainRaw getStxSupplyRaw getStxSupplyTotalSupplyPlain getStxSupplyTotalSupplyPlainRaw getTotalStxSupplyLegacyFormat getTotalStxSupplyLegacyFormatRaw

Methods

getCoreApiInfo

getCoreApiInfo(initOverrides?: RequestInit): Promise<CoreNodeInfoResponse>
Retrieves information about the Core API including the server version Get Core API info
Parameters
- Optional initOverrides: RequestInit
Returns Promise<CoreNodeInfoResponse>
- Defined in src/generated/apis/InfoApi.ts:73

getCoreApiInfoRaw

getCoreApiInfoRaw(initOverrides?: RequestInit): Promise<ApiResponse<CoreNodeInfoResponse>>
Retrieves information about the Core API including the server version

Summary
Get Core API info

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CoreNodeInfoResponse>>
- Defined in src/generated/apis/InfoApi.ts:67

getNetworkBlockTimeByNetwork

getNetworkBlockTimeByNetwork(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<NetworkBlockTimeResponse>
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. Get a given network's target block time
Parameters
- requestParameters: GetNetworkBlockTimeByNetworkRequest
- Optional initOverrides: RequestInit
Returns Promise<NetworkBlockTimeResponse>
- Defined in src/generated/apis/InfoApi.ts:89

getNetworkBlockTimeByNetworkRaw

getNetworkBlockTimeByNetworkRaw(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<ApiResponse<NetworkBlockTimeResponse>>
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.

Summary
Get a given network's target block time

Throws

Memberof
InfoApiInterface
Parameters
- requestParameters: GetNetworkBlockTimeByNetworkRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<NetworkBlockTimeResponse>>
- Defined in src/generated/apis/InfoApi.ts:83

getNetworkBlockTimes

getNetworkBlockTimes(initOverrides?: RequestInit): Promise<NetworkBlockTimesResponse>
Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. Get the network target block time
Parameters
- Optional initOverrides: RequestInit
Returns Promise<NetworkBlockTimesResponse>
- Defined in src/generated/apis/InfoApi.ts:104

getNetworkBlockTimesRaw

getNetworkBlockTimesRaw(initOverrides?: RequestInit): Promise<ApiResponse<NetworkBlockTimesResponse>>
Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.

Summary
Get the network target block time

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<NetworkBlockTimesResponse>>
- Defined in src/generated/apis/InfoApi.ts:98

getPoxInfo

getPoxInfo(initOverrides?: RequestInit): Promise<CoreNodePoxResponse>
Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking. Get Proof-of-Transfer details
Parameters
- Optional initOverrides: RequestInit
Returns Promise<CoreNodePoxResponse>
- Defined in src/generated/apis/InfoApi.ts:119

getPoxInfoRaw

getPoxInfoRaw(initOverrides?: RequestInit): Promise<ApiResponse<CoreNodePoxResponse>>
Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.

Summary
Get Proof-of-Transfer details

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CoreNodePoxResponse>>
- Defined in src/generated/apis/InfoApi.ts:113

getStatus

getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>
Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information. API status
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ServerStatusResponse>
- Defined in src/generated/apis/InfoApi.ts:134

getStatusRaw

getStatusRaw(initOverrides?: RequestInit): Promise<ApiResponse<ServerStatusResponse>>
Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information.

Summary
API status

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ServerStatusResponse>>
- Defined in src/generated/apis/InfoApi.ts:128

getStxSupply

getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>
Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). Note: This uses the estimated future total supply for the year 2050. Get total and unlocked STX supply
Parameters
- requestParameters: GetStxSupplyRequest
- Optional initOverrides: RequestInit
Returns Promise<GetStxSupplyResponse>
- Defined in src/generated/apis/InfoApi.ts:150

getStxSupplyCirculatingPlain

getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>
Retrieves the STX tokens currently in circulation that have been unlocked as plain text. Get circulating STX supply in plain text format
Parameters
- Optional initOverrides: RequestInit
Returns Promise<string>
- Defined in src/generated/apis/InfoApi.ts:165

getStxSupplyCirculatingPlainRaw

getStxSupplyCirculatingPlainRaw(initOverrides?: RequestInit): Promise<ApiResponse<string>>
Retrieves the STX tokens currently in circulation that have been unlocked as plain text.

Summary
Get circulating STX supply in plain text format

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>
- Defined in src/generated/apis/InfoApi.ts:159

getStxSupplyRaw

getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<ApiResponse<GetStxSupplyResponse>>
Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). Note: This uses the estimated future total supply for the year 2050.

Summary
Get total and unlocked STX supply

Throws

Memberof
InfoApiInterface
Parameters
- requestParameters: GetStxSupplyRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GetStxSupplyResponse>>
- Defined in src/generated/apis/InfoApi.ts:144

getStxSupplyTotalSupplyPlain

getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>
Retrieves the total supply for STX tokens as plain text. Note: this uses the estimated future total supply for the year 2050. Get total STX supply in plain text format
Parameters
- Optional initOverrides: RequestInit
Returns Promise<string>
- Defined in src/generated/apis/InfoApi.ts:180

getStxSupplyTotalSupplyPlainRaw

getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<ApiResponse<string>>
Retrieves the total supply for STX tokens as plain text. Note: this uses the estimated future total supply for the year 2050.

Summary
Get total STX supply in plain text format

Throws

Memberof
InfoApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>
- Defined in src/generated/apis/InfoApi.ts:174

getTotalStxSupplyLegacyFormat

getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>
Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. Note: this uses the estimated future total supply for the year 2050. Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
Parameters
- requestParameters: GetTotalStxSupplyLegacyFormatRequest
- Optional initOverrides: RequestInit
Returns Promise<GetStxSupplyLegacyFormatResponse>
- Defined in src/generated/apis/InfoApi.ts:196

getTotalStxSupplyLegacyFormatRaw

getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<ApiResponse<GetStxSupplyLegacyFormatResponse>>
Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. Note: this uses the estimated future total supply for the year 2050.

Summary
Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)

Throws

Memberof
InfoApiInterface
Parameters
- requestParameters: GetTotalStxSupplyLegacyFormatRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GetStxSupplyLegacyFormatResponse>>
- Defined in src/generated/apis/InfoApi.ts:190

Interface InfoApiInterface

Export

Interface

Hierarchy

Implemented by

Index

Methods

Methods

getCoreApiInfo

Parameters

Optional initOverrides: RequestInit

Returns Promise<CoreNodeInfoResponse>

getCoreApiInfoRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CoreNodeInfoResponse>>

getNetworkBlockTimeByNetwork

Parameters

requestParameters: GetNetworkBlockTimeByNetworkRequest

Optional initOverrides: RequestInit

Returns Promise<NetworkBlockTimeResponse>

getNetworkBlockTimeByNetworkRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetNetworkBlockTimeByNetworkRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<NetworkBlockTimeResponse>>

getNetworkBlockTimes

Parameters

Optional initOverrides: RequestInit

Returns Promise<NetworkBlockTimesResponse>

getNetworkBlockTimesRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<NetworkBlockTimesResponse>>

getPoxInfo

Parameters

Optional initOverrides: RequestInit

Returns Promise<CoreNodePoxResponse>

getPoxInfoRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CoreNodePoxResponse>>

getStatus

Parameters

Optional initOverrides: RequestInit

Returns Promise<ServerStatusResponse>

getStatusRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<ServerStatusResponse>>

getStxSupply

Parameters

requestParameters: GetStxSupplyRequest

Optional initOverrides: RequestInit

Returns Promise<GetStxSupplyResponse>

getStxSupplyCirculatingPlain

Parameters

Optional initOverrides: RequestInit

Returns Promise<string>

getStxSupplyCirculatingPlainRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit