s1cket/index.d.ts at master · wejesuss/s1cket · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Type definitions for s1cket api 1.0.0
// Project: https://github.com/wejesuss/s1cket
// Definitions by: Wemerson Jesus <https://github.com/wejesuss>

export interface PolishedMetaIntradayDailyAndWeekly {
    information: string;
    symbol: string;
    lastRefreshed: string;
    interval?: string;
    outputSize?: string;
    timeZone: string;
}

export type PolishedInformations = 'open' | 'high' | 'low' | 'close' | 'volume';

export interface PolishedIntradayDailyAndWeekly {
    data: PolishedMetaIntradayDailyAndWeekly | undefined;
    timeSeries:
        | Record<string, Record<PolishedInformations, string> | undefined>
        | undefined;
    error?: string;
}

export interface PolishedSearchResults {
    symbol: string;
    name: string;
    type: string;
    region: string;
    marketOpen: string;
    marketClose: string;
    timezone: string;
    currency: string;
    matchScore: string;
}

export type PolishedSearch = PolishedSearchResults[];

export interface PolishedCriptoMetaData {
    information: string;
    digitalCurrencyCode: string;
    digitalCurrencyName: string;
    marketCode: string;
    marketName: string;
    lastRefreshed: string;
    timeZone: string;
}

export type PolishedCriptoSeriesData = {
    // something like 'openCNY' and 'highCNY'
    [key: string]: string;
    openUSD: string;
    highUSD: string;
    lowUSD: string;
    closeUSD: string;
    volume: string;
    marketCapUSD: string;
};

export interface PolishedCriptoSeries {
    data: PolishedCriptoMetaData | undefined;
    timeSeries:
        | Record<string, PolishedCriptoSeriesData | undefined>
        | undefined;
    error?: string;
}

export interface PolishedExchangeRate {
    currencyExchangeRate: {
        fromCurrencyCode: string;
        fromCurrencyName: string;
        toCurrencyCode: string;
        toCurrencyName: string;
        exchangeRate: string;
        lastRefreshed: string;
        timeZone: string;
        bidPrice: string;
        askPrice: string;
    };
}

export interface GlobalQuoteResults {
    symbol: string;
    open: string;
    high: string;
    low: string;
    price: string;
    volume: string;
    latestTradingDay: string;
    previousClose: string;
    change: string;
    changePercent: string;
}

export interface PolishedGlobalQuote {
    globalQuote: GlobalQuoteResults;
}