Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chainseeker/chainseeker-client
A JavaScript, Node.js, TypeScript library for accessing chainseeker's API endpoints.
https://github.com/chainseeker/chainseeker-client
api bitcoin blockexplorer monacoin rest typescript
Last synced: 27 days ago
JSON representation
A JavaScript, Node.js, TypeScript library for accessing chainseeker's API endpoints.
- Host: GitHub
- URL: https://github.com/chainseeker/chainseeker-client
- Owner: chainseeker
- Created: 2019-08-26T13:26:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:38:33.000Z (almost 2 years ago)
- Last Synced: 2024-11-12T22:22:10.930Z (about 2 months ago)
- Topics: api, bitcoin, blockexplorer, monacoin, rest, typescript
- Language: TypeScript
- Homepage: https://chainseeker.info
- Size: 921 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
chainseeker-lib
===============
[](https://github.com/chainseeker/chainseeker-client/actions/workflows/node.js.yml)
[](https://badge.fury.io/js/chainseeker)
[](https://codecov.io/gh/chainseeker/chainseeker-client)
The official JavaScript/TypeScript API client for [chainseeker.info](https://chainseeker.info/).
Install
-------
```
$ npm install chainseeker
```
Then, you can require (Node.js) or import (TypeScript) the library.
```
import { Chainseeker } from 'chainseeker';
const cs = new Chainseeker();
```
Configure
---------
The default API endpoint is set to `https://btc-v3.chainseeker.info/api`.
If you want to use other servers, you can change the endpoint by passing endpoint URL to the `Chainseeker` constructor.
```
// Testnet
const cs = new Chainseeker('https://tbtc-v3.chainseeker.info/api');
```
```
// Signet
const cs = new Chainseeker('https://sbtc-v3.chainseeker.info/api');
```
```
// Monacoin
const cs = new Chainseeker('https://mona-v3.chainseeker.info/api');
```
API
---
The object type returned by the client is defined in [./src/types.ts](./src/types.ts).
### getStatus(): Status
Get the synchronization status.
### getBlockHeader(blockIdOrHeight: string|number): BlockHeader
Get a block data without any transaction information.
### getBlockWithTxids(blockIdOrHeight: string|number): BlockWithTxids
Get a block data with transaction IDs included in the block.
### getBlockWithTxs(blockIdOrHeight: string|number): BlockWithTxs
Get a block data with transactions included in the block.
Warning: this API may return a huge (~10MiB) data.
If you want a small chunk of transactions in a block, call `getBlockWithTxids()` and fetch transactions with `getTransaction()`.
### getTransaction(txid: string): Transaction
Get a transaction data.
### getTxIds(address: string): string[]
Get the array of transaction ids related to an address.
### getUtxos(address: string): Utxo[]
Get UTXOs for the given address.
### putTransaction(rawtx: string): string
Broadcast a raw transaction data.
On success, return the transaction ID.
### getBlockSummary(offset: number, limit: number) BlockSummaryEntry[]
Get a block summary data, including nonces, sizes of a block and the number of transactions.
### getRichListCount: number
The number of addresses in the rich list.
### getRichList(offset: number, limit: number): RichListEntry[]
Get the `(offset + 1)`-th to `(offets + limit + 1)-th` richest addresses.
The `offset` starts from zero.
### getRichListRank(address: string): number|null
Get the rich list rank of a given address.
The rank starts with one.