@parcl-finance/product-sdk/dist/cjs/market.d.ts

TypeScript SDK for interacting with Parcl's product APIs

import { BaseMarketCategory, MarketTags } from "./account";
import { Currency, Env } from "./types";
export declare class Market {
    private headers;
    private expressClient;
    constructor(env?: Env);
    getMarketBySymbol({ symbol }: {
        symbol: string;
    }): Promise<FullMarketInfo>;
    getMarketVolumesBySymbol({ symbol }: {
        symbol: string;
    }): Promise<VolumeTimeframes>;
    getMarketFilterDistributions(): Promise<MarketFilterDistributions>;
    getMarketsBySymbols({ symbols }: {
        symbols: string[];
    }): Promise<FullMarketInfo[]>;
}
export type MarketFilterDistributions = {
    indexPrice: DistInfo;
    marketPrice: DistInfo;
    indexPriceTrend: DistInfoWithTimeframes;
    marketPriceTrend: DistInfoWithTimeframes;
    volume: DistInfoWithTimeframes;
    openInterest: DistInfo;
    fundingRate: DistInfo;
    fpu: DistInfo;
};
export type DistInfoWithTimeframes = {
    "1d": DistInfo;
    "1w": DistInfo;
    "1m": DistInfo;
    "3m": DistInfo;
    "6m": DistInfo;
    "1y": DistInfo;
    "5y": DistInfo;
};
export type DistInfo = {
    min: string;
    max: string;
    dist: number[];
};
export type VolumeTimeframes = {
    volume1d: string | null;
    volume1w: string | null;
    volume1m: string | null;
    volume3m: string | null;
    volume6m: string | null;
    volume1y: string | null;
    volume5y: string | null;
};
export type FullMarketInfo = {
    symbol: string;
    marketId: string | null;
    name: string;
    address: string;
    parclId: number | null;
    priceFeed: string;
    isNew: boolean;
    tradable: boolean;
    marketCategory: BaseMarketCategory;
    currency: Currency;
    metric: string | null;
    pythTokenId: string | null;
    tags: MarketTags[];
    marketPrice: string | null;
    indexPrice: string | null;
    fundingPerUnit: string | null;
    skew: string | null;
    marketSize: string | null;
    fundingRate: string | null;
    fundingVelocity: string | null;
    totalOpenInterest: string | null;
    volume1d: string | null;
    volume1w: string | null;
    volume1m: string | null;
    volume3m: string | null;
    volume6m: string | null;
    volume1y: string | null;
    volume5y: string | null;
    marketPriceTrend1d: string | null;
    marketPriceTrend1w: string | null;
    marketPriceTrend1m: string | null;
    marketPriceTrend3m: string | null;
    marketPriceTrend6m: string | null;
    marketPriceTrend1y: string | null;
    marketPriceTrend5y: string | null;
    marketDollarChange1d: string | null;
    marketDollarChange1w: string | null;
    marketDollarChange1m: string | null;
    marketDollarChange3m: string | null;
    marketDollarChange6m: string | null;
    marketDollarChange1y: string | null;
    marketDollarChange5y: string | null;
    indexPriceTrend1d: string | null;
    indexPriceTrend1w: string | null;
    indexPriceTrend1m: string | null;
    indexPriceTrend3m: string | null;
    indexPriceTrend6m: string | null;
    indexPriceTrend1y: string | null;
    indexPriceTrend5y: string | null;
    indexDollarChange1d: string | null;
    indexDollarChange1w: string | null;
    indexDollarChange1m: string | null;
    indexDollarChange3m: string | null;
    indexDollarChange6m: string | null;
    indexDollarChange1y: string | null;
    indexDollarChange5y: string | null;
};
//# sourceMappingURL=market.d.ts.map