@mcp3/dex-screener
Version:
DexScreener API integration for MCP3
165 lines • 4.22 kB
TypeScript
/**
* DexScreener API client
*/
export declare class DexScreenerClient {
private baseUrl;
/**
* Create a new DexScreener API client
* @param options Client options
*/
constructor(options?: {
baseUrl?: string;
});
/**
* Get the latest token profiles
* @returns The latest token profiles
*/
getTokenProfiles(): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Get the latest boosted tokens
* @returns The latest boosted tokens
*/
getTokenBoosts(): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Get the tokens with most active boosts
* @returns The tokens with most active boosts
*/
getTopTokenBoosts(): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Check orders paid for of token
* @param chainId The chain ID
* @param tokenAddress The token address
* @returns The orders paid for of token
*/
getOrders(chainId: string, tokenAddress: string): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Get one or multiple pairs by chain and pair address
* @param chainId The chain ID
* @param pairId The pair ID
* @returns The pairs
*/
getPairsByChainAndPairAddress(chainId: string, pairId: string): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Search for pairs matching query
* @param query The search query
* @returns The pairs matching the query
*/
searchPairs(query: string): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Get the pools of a given token address
* @param chainId The chain ID
* @param tokenAddress The token address
* @returns The pools of the token
*/
getPoolsByTokenAddress(chainId: string, tokenAddress: string): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Get one or multiple pairs by token address
* @param chainId The chain ID
* @param tokenAddresses One or multiple, comma-separated token addresses (up to 30 addresses)
* @returns The pairs
*/
getPairsByTokenAddress(chainId: string, tokenAddresses: string): Promise<{
uri: string;
status: number;
message: string;
isError: boolean;
result?: undefined;
} | {
uri: string;
status: number;
result: unknown;
message?: undefined;
isError?: undefined;
}>;
/**
* Fetch JSON from the API
* @param path The API path
* @returns The JSON response
*/
private fetchJson;
}
//# sourceMappingURL=client.d.ts.map