Skip to content

Commit

Permalink
docs(readme): Added documentation for market status endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
zaevimn committed Sep 6, 2024
1 parent 0d316ca commit 1e8e193
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
- [Monthly](#monthly)
- [Monthly Adjusted](#monthly-adjusted)
- [Quote Endpoint](#quote-endpoint)
- [Market Status](#market-status-endpoint)
- [Fundamental data](#fundamental-data)
- [Company Overview](#company-overview)
- [Earnings](#earnings)
Expand Down Expand Up @@ -482,6 +483,58 @@ av.stockTimeSeries.quote({ symbol: 'IBM' }).then((data) => console.log(data))
}
```

---
### Market Status Endpoint

```js
av.stockTimeSeries.marketStatus().then((data) => console.log(data))
```

## Enums

```ts
enum MarketType {
EQUTY = "Equity",
FOREX = "Forex",
CRYPTO = "Cryptocurrency",
}
```

```ts
enum MarketStatus {
OPEN = "open",
CLOSE = "close",
}
```

**Response**

```js
{
endpoint: string;
markets: [
{
marketType: MarketType;
region: string;
primaryExchanges: string;
localOpen: string;
localClose: string;
currentStatus: MarketStatus;
notes: string;
},
{
marketType: MarketType;
region: string;
primaryExchanges: string;
localOpen: string;
localClose: string;
currentStatus: MarketStatus;
notes: string;
},
]
}
```

---

## Fundamental data
Expand Down

0 comments on commit 1e8e193

Please sign in to comment.