Class: PublicApi
PublicApi - object-oriented interface
Export
Hierarchy
↳
PublicApi
Table of contents
Constructors
Properties
Methods
- publicByCidCidGet
- publicInfoGet
- publicMetricsDealsOnChainGet
- publicMinersDealsMinerGet
- publicMinersFailuresMinerGet
- publicMinersGet
- publicMinersStatsMinerGet
- publicNetAddrsGet
- publicNetPeersGet
- publicStatsGet
Constructors
constructor
• new PublicApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
publicByCidCidGet
▸ publicByCidCidGet(cid, options?): Promise<Response>
This endpoint returns the content associated with a CID
Summary
Get Content by Cid
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
cid | string | Cid |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7275
publicInfoGet
▸ publicInfoGet(options?): Promise<Response>
This endpoint returns information about the node
Summary
Get public node info
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7286
publicMetricsDealsOnChainGet
▸ publicMetricsDealsOnChainGet(options?): Promise<Response>
This endpoint is used to get deal metrics
Summary
Get deal metrics
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7297
publicMinersDealsMinerGet
▸ publicMinersDealsMinerGet(miner, ignoreFailed?, options?): Promise<Response>
This endpoint returns all miners deals
Summary
Get all miners deals
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
ignoreFailed? | string | Ignore Failed |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7310
publicMinersFailuresMinerGet
▸ publicMinersFailuresMinerGet(miner, options?): Promise<Response>
This endpoint returns all miners
Summary
Get all miners
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7322
publicMinersGet
▸ publicMinersGet(options?): Promise<Response>
This endpoint returns all miners
Summary
Get all miners
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7333
publicMinersStatsMinerGet
▸ publicMinersStatsMinerGet(miner, options?): Promise<Response>
This endpoint returns miner stats
Summary
Get miner stats
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7345
publicNetAddrsGet
▸ publicNetAddrsGet(options?): Promise<string[]>
This endpoint is used to get net addrs
Summary
Net Addrs
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7356
publicNetPeersGet
▸ publicNetPeersGet(options?): Promise<string[]>
This endpoint is used to get net peers
Summary
Net Peers
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7367
publicStatsGet
▸ publicStatsGet(options?): Promise<Response>
This endpoint is used to get public stats.
Summary
Public stats
Throws
Memberof
PublicApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>