adamant-api / api / GetPeersOptions

Interface: GetPeersOptions

Defined in: src/api/index.ts:198

Properties

broadhash?

optional broadhash?: string;

Defined in: src/api/index.ts:221

Filter by hexadecimal broadhash.

---

height?

optional height?: number;

Defined in: src/api/index.ts:223

Filter by blockchain height.

---

ip?

optional ip?: string;

Defined in: src/api/index.ts:213

Filter by IP address.

---

limit?

optional limit?: number;

Defined in: src/api/index.ts:200

Number of peers to retrieve, from 1 to 100.

---

offset?

optional offset?: number;

Defined in: src/api/index.ts:202

Number of peers to skip. Defaults to 0.

---

orderBy?

optional orderBy?: string;

Defined in: src/api/index.ts:209

Sort field and direction, for example height:desc.

Supported fields are ip, port, state, os, version, broadhash, height, and nonce.

---

os?

optional os?: string;

Defined in: src/api/index.ts:211

Filter by operating system.

---

port?

optional port?: number;

Defined in: src/api/index.ts:215

Filter by node port, from 1 to 65535.

---

state?

optional state?: 0 | 1 | 2;

Defined in: src/api/index.ts:217

Filter by peer state: banned, disconnected, or connected.

---

version?

optional version?: string;

Defined in: src/api/index.ts:219

Filter by semantic ADAMANT Node version.