Skip to main content

@elizaos/core v1.0.6 / ITokenDataService

Class: abstract ITokenDataService

Interface for a generic service that provides token data.

Extends​

Properties​

runtime​

protected runtime: IAgentRuntime

Runtime instance

Inherited from​

Service.runtime

Defined in​

packages/core/src/types/service.ts:105

config?​

optional config: Metadata

Service configuration

Inherited from​

Service.config

Defined in​

packages/core/src/types/service.ts:122

serviceType​

readonly static serviceType: "token_data" = ServiceType.TOKEN_DATA

Service type

Overrides​

Service.serviceType

Defined in​

packages/core/src/types/token.ts:51

capabilityDescription​

readonly capabilityDescription: string

Service name

Overrides​

Service.capabilityDescription

Defined in​

packages/core/src/types/token.ts:52

Methods​

start()​

static start(_runtime): Promise<Service>

Start service connection

Parameters​

• _runtime: IAgentRuntime

Returns​

Promise<Service>

Inherited from​

Service.start

Defined in​

packages/core/src/types/service.ts:125

stop()​

static stop(_runtime): Promise<unknown>

Stop service connection

Parameters​

• _runtime: IAgentRuntime

Returns​

Promise<unknown>

Inherited from​

Service.stop

Defined in​

packages/core/src/types/service.ts:130

getTokenDetails()​

abstract getTokenDetails(address, chain): Promise<TokenData>

Fetches detailed information for a single token.

Parameters​

• address: string

The token's contract address.

• chain: string

The blockchain the token resides on.

Returns​

Promise<TokenData>

A Promise resolving to TokenData or null if not found.

Defined in​

packages/core/src/types/token.ts:61

getTrendingTokens()​

abstract getTrendingTokens(chain?, limit?, timePeriod?): Promise<TokenData[]>

Fetches a list of trending tokens.

Parameters​

• chain?: string

Optional: Filter by a specific blockchain.

• limit?: number

Optional: Number of tokens to return. Defaults to a service-specific value.

• timePeriod?: string

Optional: Time period for trending data (e.g., '24h', '7d'). Defaults to service-specific.

Returns​

Promise<TokenData[]>

A Promise resolving to an array of TokenData.

Defined in​

packages/core/src/types/token.ts:70

searchTokens()​

abstract searchTokens(query, chain?, limit?): Promise<TokenData[]>

Searches for tokens based on a query string.

Parameters​

• query: string

The search query (e.g., symbol, name, address).

• chain?: string

Optional: Filter by a specific blockchain.

• limit?: number

Optional: Number of results to return.

Returns​

Promise<TokenData[]>

A Promise resolving to an array of TokenData.

Defined in​

packages/core/src/types/token.ts:83

getTokensByAddresses()​

abstract getTokensByAddresses(addresses, chain): Promise<TokenData[]>

Fetches data for multiple tokens by their addresses on a specific chain.

Parameters​

• addresses: string[]

Array of token contract addresses.

• chain: string

The blockchain the tokens reside on.

Returns​

Promise<TokenData[]>

A Promise resolving to an array of TokenData. May not include all requested if some are not found.

Defined in​

packages/core/src/types/token.ts:91