opensea-cli 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,493 @@
+type Chain = "ethereum" | "polygon" | "base" | "blast" | "arbitrum" | "avalanche" | "optimism" | "solana" | "zora" | "sei" | "b3" | "bera_chain" | "ape_chain" | "flow" | "ronin" | "abstract" | "shape" | "unichain" | "gunzilla" | "hyperevm" | "somnia" | "monad";
+type SafelistStatus = "not_requested" | "requested" | "approved" | "verified" | "disabled_top_trending";
+type CollectionOrderBy = "created_date" | "one_day_change" | "seven_day_volume" | "seven_day_change" | "num_owners" | "market_cap";
+type EventType = "sale" | "transfer" | "mint" | "listing" | "offer" | "trait_offer" | "collection_offer";
+type OrderSide = "ask" | "bid";
+interface Fee {
+    fee: number;
+    recipient: string;
+    required: boolean;
+}
+interface PaymentToken {
+    name: string;
+    symbol: string;
+    decimals: number;
+    address: string;
+    chain: Chain;
+    image_url?: string;
+    eth_price?: string;
+    usd_price?: string;
+}
+interface Collection {
+    name: string;
+    collection: string;
+    description: string;
+    image_url: string;
+    banner_image_url: string;
+    owner: string;
+    safelist_status: SafelistStatus;
+    category: string;
+    is_disabled: boolean;
+    is_nsfw: boolean;
+    trait_offers_enabled: boolean;
+    collection_offers_enabled: boolean;
+    opensea_url: string;
+    project_url: string;
+    wiki_url: string;
+    discord_url: string;
+    telegram_url: string;
+    twitter_username: string;
+    instagram_username: string;
+    contracts: {
+        address: string;
+        chain: Chain;
+    }[];
+    editors: string[];
+    fees: Fee[];
+    rarity: {
+        strategy_id: string;
+        strategy_version: string;
+        calculated_at: string;
+        max_rank: number;
+        tokens_scored: number;
+    } | null;
+    payment_tokens: PaymentToken[];
+    total_supply: number;
+    created_date: string;
+    required_zone?: string;
+}
+interface CollectionStats {
+    total: {
+        volume: number;
+        sales: number;
+        average_price: number;
+        num_owners: number;
+        market_cap: number;
+        floor_price: number;
+        floor_price_symbol: string;
+    };
+    intervals: {
+        interval: "one_day" | "seven_day" | "thirty_day";
+        volume: number;
+        volume_diff: number;
+        volume_change: number;
+        sales: number;
+        sales_diff: number;
+        average_price: number;
+    }[];
+}
+interface NFT {
+    identifier: string;
+    collection: string;
+    contract: string;
+    token_standard: string;
+    name: string;
+    description: string;
+    image_url: string;
+    metadata_url: string;
+    opensea_url: string;
+    updated_at: string;
+    is_disabled: boolean;
+    is_nsfw: boolean;
+    traits: Trait[] | null;
+    creator: string;
+    owners: {
+        address: string;
+        quantity: number;
+    }[];
+    rarity: {
+        strategy_id: string | null;
+        strategy_version: string | null;
+        rank: number | null;
+        score: number | null;
+        calculated_at: string;
+        max_rank: number | null;
+        tokens_scored: number | null;
+        ranking_features: {
+            unique_attribute_count: number;
+        } | null;
+    } | null;
+}
+interface Trait {
+    trait_type: string;
+    display_type: string;
+    max_value: string;
+    value: string | number;
+}
+interface Price {
+    currency: string;
+    decimals: number;
+    value: string;
+}
+interface Order {
+    order_hash: string;
+    chain: string;
+    protocol_data: Record<string, unknown>;
+    protocol_address: string;
+    price: Price;
+}
+interface Offer extends Order {
+    criteria?: {
+        collection: {
+            slug: string;
+        };
+        contract: {
+            address: string;
+        };
+        encoded_token_ids?: string;
+        trait?: {
+            type: string;
+            value: string;
+        };
+    };
+    status: string;
+}
+interface Listing extends Omit<Order, "price"> {
+    type: string;
+    price: {
+        current: Price;
+    };
+    remaining_quantity: number;
+    status: string;
+}
+interface EventPayment {
+    quantity: string;
+    token_address: string;
+    decimals: number;
+    symbol: string;
+}
+interface EventAsset {
+    identifier: string;
+    collection: string;
+    contract: string;
+    token_standard: string;
+    name: string;
+    description: string;
+    image_url: string;
+    metadata_url: string;
+    opensea_url: string;
+    updated_at: string;
+    is_disabled: boolean;
+    is_nsfw: boolean;
+}
+interface AssetEvent {
+    event_type: string;
+    event_timestamp: number;
+    chain: string;
+    quantity: number;
+    [key: string]: unknown;
+}
+interface Contract {
+    address: string;
+    chain: string;
+    collection: string | null;
+    name: string;
+    contract_standard: string;
+}
+interface Account {
+    address: string;
+    username: string;
+    profile_image_url: string;
+    banner_image_url: string;
+    website: string;
+    social_media_accounts: {
+        platform: string;
+        username: string;
+    }[];
+    bio: string;
+    joined_date: string;
+}
+interface TraitCategories {
+    [traitType: string]: "string" | "number" | "date";
+}
+interface TraitCounts {
+    [traitValue: string]: number;
+}
+interface GetTraitsResponse {
+    categories: TraitCategories;
+    counts: {
+        [traitType: string]: TraitCounts;
+    };
+}
+interface PaginatedResponse<T> {
+    next?: string;
+    results: T[];
+}
+interface Token {
+    address: string;
+    chain: string;
+    name: string;
+    symbol: string;
+    image_url?: string;
+    usd_price: string;
+    decimals: number;
+    market_cap_usd?: number;
+    volume_24h?: number;
+    price_change_24h?: number;
+    opensea_url: string;
+}
+interface TokenDetails {
+    address: string;
+    chain: string;
+    name: string;
+    symbol: string;
+    image_url?: string;
+    description?: string;
+    usd_price: string;
+    decimals: number;
+    stats?: TokenStats;
+    socials?: TokenSocials;
+    opensea_url: string;
+}
+interface TokenStats {
+    market_cap_usd?: number;
+    fdv_usd?: number;
+    circulating_supply?: number;
+    max_supply?: number;
+    total_supply?: number;
+    volume_24h?: number;
+    price_change_1h?: number;
+    price_change_24h?: number;
+    price_change_7d?: number;
+    price_change_30d?: number;
+}
+interface TokenSocials {
+    website?: string;
+    twitter_handle?: string;
+    telegram_identifier?: string;
+}
+interface SwapQuote {
+    total_price_usd: number;
+    total_cost_usd: number;
+    slippage_tolerance: number;
+    estimated_duration_ms: number;
+    marketplace_fee_bps: number;
+}
+interface SwapTransaction {
+    chain: string;
+    to?: string;
+    data: string;
+    value?: string;
+}
+interface SwapQuoteResponse {
+    quote: SwapQuote;
+    transactions: SwapTransaction[];
+}
+
+interface OpenSeaClientConfig {
+    apiKey: string;
+    baseUrl?: string;
+    chain?: string;
+}
+interface CommandOptions {
+    apiKey?: string;
+    chain?: string;
+    format?: "json" | "table";
+    raw?: boolean;
+}
+
+declare class OpenSeaClient {
+    private apiKey;
+    private baseUrl;
+    private defaultChain;
+    constructor(config: OpenSeaClientConfig);
+    get<T>(path: string, params?: Record<string, unknown>): Promise<T>;
+    post<T>(path: string): Promise<T>;
+    getDefaultChain(): string;
+}
+declare class OpenSeaAPIError extends Error {
+    statusCode: number;
+    responseBody: string;
+    path: string;
+    constructor(statusCode: number, responseBody: string, path: string);
+}
+
+declare class OpenSeaCLI {
+    private client;
+    readonly collections: CollectionsAPI;
+    readonly nfts: NFTsAPI;
+    readonly listings: ListingsAPI;
+    readonly offers: OffersAPI;
+    readonly events: EventsAPI;
+    readonly accounts: AccountsAPI;
+    readonly tokens: TokensAPI;
+    readonly swaps: SwapsAPI;
+    constructor(config: OpenSeaClientConfig);
+}
+declare class CollectionsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    get(slug: string): Promise<Collection>;
+    list(options?: {
+        chain?: Chain;
+        limit?: number;
+        next?: string;
+        orderBy?: CollectionOrderBy;
+        creatorUsername?: string;
+        includeHidden?: boolean;
+    }): Promise<{
+        collections: Collection[];
+        next?: string;
+    }>;
+    stats(slug: string): Promise<CollectionStats>;
+    traits(slug: string): Promise<GetTraitsResponse>;
+}
+declare class NFTsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    get(chain: Chain, address: string, identifier: string): Promise<{
+        nft: NFT;
+    }>;
+    listByCollection(slug: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        nfts: NFT[];
+        next?: string;
+    }>;
+    listByContract(chain: Chain, address: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        nfts: NFT[];
+        next?: string;
+    }>;
+    listByAccount(chain: Chain, address: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        nfts: NFT[];
+        next?: string;
+    }>;
+    refresh(chain: Chain, address: string, identifier: string): Promise<void>;
+    getContract(chain: Chain, address: string): Promise<Contract>;
+}
+declare class ListingsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    all(collectionSlug: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        listings: Listing[];
+        next?: string;
+    }>;
+    best(collectionSlug: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        listings: Listing[];
+        next?: string;
+    }>;
+    bestForNFT(collectionSlug: string, tokenId: string): Promise<Listing>;
+}
+declare class OffersAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    all(collectionSlug: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        offers: Offer[];
+        next?: string;
+    }>;
+    collection(collectionSlug: string, options?: {
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        offers: Offer[];
+        next?: string;
+    }>;
+    bestForNFT(collectionSlug: string, tokenId: string): Promise<Offer>;
+    traits(collectionSlug: string, options: {
+        type: string;
+        value: string;
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        offers: Offer[];
+        next?: string;
+    }>;
+}
+declare class EventsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    list(options?: {
+        eventType?: EventType;
+        after?: number;
+        before?: number;
+        limit?: number;
+        next?: string;
+        chain?: Chain;
+    }): Promise<{
+        asset_events: AssetEvent[];
+        next?: string;
+    }>;
+    byAccount(address: string, options?: {
+        eventType?: EventType;
+        limit?: number;
+        next?: string;
+        chain?: Chain;
+    }): Promise<{
+        asset_events: AssetEvent[];
+        next?: string;
+    }>;
+    byCollection(collectionSlug: string, options?: {
+        eventType?: EventType;
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        asset_events: AssetEvent[];
+        next?: string;
+    }>;
+    byNFT(chain: Chain, address: string, identifier: string, options?: {
+        eventType?: EventType;
+        limit?: number;
+        next?: string;
+    }): Promise<{
+        asset_events: AssetEvent[];
+        next?: string;
+    }>;
+}
+declare class AccountsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    get(address: string): Promise<Account>;
+}
+declare class TokensAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    trending(options?: {
+        limit?: number;
+        chains?: string[];
+        cursor?: string;
+    }): Promise<{
+        tokens: Token[];
+        next?: string;
+    }>;
+    top(options?: {
+        limit?: number;
+        chains?: string[];
+        cursor?: string;
+    }): Promise<{
+        tokens: Token[];
+        next?: string;
+    }>;
+    get(chain: Chain, address: string): Promise<TokenDetails>;
+}
+declare class SwapsAPI {
+    private client;
+    constructor(client: OpenSeaClient);
+    quote(options: {
+        fromChain: string;
+        fromAddress: string;
+        toChain: string;
+        toAddress: string;
+        quantity: string;
+        address: string;
+        slippage?: number;
+        recipient?: string;
+    }): Promise<SwapQuoteResponse>;
+}
+
+export { type Account, type AssetEvent, type Chain, type Collection, type CollectionOrderBy, type CollectionStats, type CommandOptions, type Contract, type EventAsset, type EventPayment, type EventType, type Fee, type GetTraitsResponse, type Listing, type NFT, type Offer, OpenSeaAPIError, OpenSeaCLI, OpenSeaClient, type OpenSeaClientConfig, type Order, type OrderSide, type PaginatedResponse, type PaymentToken, type Price, type SafelistStatus, type SwapQuote, type SwapQuoteResponse, type SwapTransaction, type Token, type TokenDetails, type TokenSocials, type TokenStats, type Trait, type TraitCategories, type TraitCounts };