dexscreener-sdk/dist/models/TokenProfile.d.ts

A TypeScript wrapper for the DEX Screener API, providing easy access to token profiles, boosts, orders, pairs, and more.

import { BaseModel } from './BaseModel.js';
/**
 * Interface representing a link object in a token profile.
 */
export interface ILink {
    /** Optional type (e.g., "twitter", "telegram"). */
    type?: string;
    /** Optional label for the link (e.g., "Website", "Docs"). */
    label?: string;
    /** URL for the link. */
    url: string;
}
/**
 * TokenProfile represents the metadata of a token.
 */
export declare class TokenProfile extends BaseModel {
    /** URL to the token's DEX Screener page. */
    url: string;
    /** Blockchain network identifier (e.g., "solana", "base"). */
    chainId: string;
    /** The unique token address. */
    tokenAddress: string;
    /** URL to the token icon image. */
    icon: string;
    /** URL to a header image. */
    header: string;
    /** URL to the Open Graph image. */
    openGraph: string;
    /** A description of the token. */
    description: string;
    /** An array of related links. */
    links: ILink[];
    /**
     * Creates an instance of TokenProfile.
     * @param data Partial data to initialize the token profile.
     */
    constructor(data: Partial<TokenProfile>);
}