Skip to content

Commit cc05ced

Browse files
authored
Merge pull request #27 from alpacahq/add-doc
Fix typo, add polygon fundamental doc
2 parents 84ae722 + fbfda50 commit cc05ced

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Calls `GET /orders/{order_id}` and returns an `Order` entity.
108108
### REST.cancel_order(order_id)
109109
Calls `DELETE /orders/{order_id}`.
110110

111-
### REST.list_position()
111+
### REST.list_positions()
112112
Calls `GET /positions` and returns a list of `Position` entities.
113113

114114
### REST.get_position(symbol)
@@ -206,16 +206,6 @@ Deregisters the event handler function that was previously registered via `on` o
206206
`register` method.
207207

208208

209-
## Support and Contribution
210-
211-
For technical issues particular to this module, please report the
212-
issue on this GitHub repository. Any API issues can be reported through
213-
Alpaca's customer support.
214-
215-
New features, as well as bug fixes, by sending pull request is always
216-
welcomed.
217-
218-
219209
---
220210
# Polygon API Service
221211

@@ -287,3 +277,35 @@ Returns a `Quote` entity representing the last quote for the symbol.
287277

288278
### polygon/REST.condition_map(ticktype='trades')
289279
Returns a `ConditionMap` entity.
280+
281+
### polygon/REST.company(symbol)
282+
Returns a `Company` entity if `symbol` is string, or a
283+
dict[symbol -> `Company`] if `symbol` is a list of string.
284+
285+
### polygon/REST.dividends(symbol)
286+
Returns a `Dividends` entity if `symbol` is string, or a
287+
dict[symbol -> `Dividends`] if `symbol is a list of string.
288+
289+
### polygon/REST.splits(symbol)
290+
Returns a `Splits` entity for the symbol.
291+
292+
## polygon/REST.earnings(symbol)
293+
Returns an `Earnings` entity if `symbol` is string, or a
294+
dict[symbol -> `Earnings`] if `symbol` is a list of string.
295+
296+
## polygon/REST.financials(symbol)
297+
Returns an `Financials` entity if `symbol` is string, or a
298+
dict[symbol -> `Financials`] if `symbol` is a list of string.
299+
300+
### polygon/REST.news(symbol)
301+
Returns a `NewsList` entity for the symbol.
302+
303+
304+
## Support and Contribution
305+
306+
For technical issues particular to this module, please report the
307+
issue on this GitHub repository. Any API issues can be reported through
308+
Alpaca's customer support.
309+
310+
New features, as well as bug fixes, by sending pull request is always
311+
welcomed.

0 commit comments

Comments
 (0)