Skip to content

Commit

Permalink
refactor: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
117 committed Apr 2, 2024
1 parent 5c0e3ec commit 321eb56
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const client = createClient({
key: "YOUR_API_KEY_ID",
secret: "YOUR_API_SECRET_KEY",
// Or, provide an access token if you're using OAuth.
// token: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
// accessToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
});
```

Expand Down Expand Up @@ -639,6 +639,8 @@ client

#### getStocksCorporateActions

Retrieves a list of corporate actions based on the specified parameters.

```typescript
client
.getStocksCorporateActions({
Expand All @@ -650,6 +652,8 @@ client

#### getLogo

Retrieves the logo for a specific symbol.

```typescript
client
.getLogo({
Expand All @@ -660,6 +664,8 @@ client

#### getNews

Retrieves the latest news.

```typescript
client
.getNews({
Expand All @@ -671,6 +677,8 @@ client

#### getStocksMostActives

Retrieves a list of the most active stocks.

```typescript
client
.getStocksMostActives({
Expand All @@ -682,6 +690,8 @@ client

#### getStocksMarketMovers

Retrieves a list of the top market movers.

```typescript
client
.getStocksMarketMovers({
Expand All @@ -693,6 +703,8 @@ client

#### getStocksQuotes

Retrieves a list of stock quotes.

```typescript
client
.getStocksQuotes({
Expand All @@ -704,6 +716,8 @@ client

#### getStocksQuotesLatest

Retrieves the latest stock quotes.

```typescript
client
.getStocksQuotesLatest({
Expand All @@ -714,6 +728,8 @@ client

#### getStocksBars

Retrieves a list of stock bars.

```typescript
client
.getStocksBars({
Expand All @@ -726,6 +742,8 @@ client

#### getStocksBarsLatest

Retrieves the latest stock bars.

```typescript
client
.getStocksBarsLatest({
Expand All @@ -736,6 +754,8 @@ client

#### getForexRates

Retrieves a list of forex rates.

```typescript
client
.getForexRates({
Expand All @@ -748,6 +768,8 @@ client

#### getLatestForexRates

Retrieves the latest forex rates.

```typescript
client
.getLatestForexRates({
Expand All @@ -758,6 +780,8 @@ client

#### getStocksSnapshots

Retrieves a list of stock snapshots.

```typescript
client
.getStocksSnapshots({
Expand All @@ -768,6 +792,8 @@ client

#### getStocksAuctions

Retrieves a list of stock auctions.

```typescript
client
.getStocksAuctions({
Expand All @@ -779,6 +805,8 @@ client

#### getStocksConditions

Retrieves a list of stock conditions.

```typescript
client
.getStocksConditions({
Expand All @@ -790,12 +818,16 @@ client

#### getStocksExchangeCodes

Retrieves a list of stock exchange codes.

```typescript
client.getStocksExchangeCodes().then(console.log);
```

#### getStocksTrades

Retrieves a list of stock trades.

```typescript
client
.getStocksTrades({
Expand All @@ -807,6 +839,8 @@ client

#### getStocksTradesLatest

Retrieves the latest stock trades.

```typescript
client
.getStocksTradesLatest({
Expand All @@ -817,6 +851,8 @@ client

#### getOptionsBars

Retrieves a list of options bars.

```typescript
client
.getOptionsBars({
Expand All @@ -829,12 +865,16 @@ client

#### getOptionsExchanges

Retrieves a list of options exchanges.

```typescript
client.getOptionsExchanges().then(console.log);
```

#### getOptionsSnapshots

Retrieves a list of options snapshots.

```typescript
client
.getOptionsSnapshots({
Expand All @@ -845,6 +885,8 @@ client

#### getOptionsTrades

Retrieves a list of options trades.

```typescript
client
.getOptionsTrades({
Expand All @@ -856,6 +898,8 @@ client

#### getOptionsTradesLatest

Retrieves the latest options trades.

```typescript
client
.getOptionsTradesLatest({
Expand All @@ -866,6 +910,8 @@ client

#### getCryptoBars

Retrieves a list of crypto bars.

```typescript
client
.getCryptoBars({
Expand All @@ -878,6 +924,8 @@ client

#### getLatestCryptoBars

Retrieves the latest crypto bars.

```typescript
client
.getLatestCryptoBars({
Expand All @@ -889,6 +937,8 @@ client

#### getCryptoQuotes

Retrieves a list of crypto quotes.

```typescript
client
.getCryptoQuotes({
Expand All @@ -900,6 +950,8 @@ client

#### getCryptoQuotesLatest

Retrieves the latest crypto quotes.

```typescript
client
.getCryptoQuotesLatest({
Expand All @@ -911,6 +963,8 @@ client

#### getCryptoSnapshots

Retrieves a list of crypto snapshots.

```typescript
client
.getCryptoSnapshots({
Expand All @@ -922,6 +976,8 @@ client

#### getCryptoTrades

Retrieves a list of crypto trades.

```typescript
client
.getCryptoTrades({
Expand All @@ -934,6 +990,8 @@ client

#### getCryptoTradesLatest

Retrieves the latest crypto trades.

```typescript
client
.getCryptoTradesLatest({
Expand All @@ -945,6 +1003,8 @@ client

#### getLatestCryptoOrderbooks

Retrieves the latest crypto orderbooks.

```typescript
client
.getLatestCryptoOrderbooks({
Expand Down

0 comments on commit 321eb56

Please sign in to comment.