Requests¶
CorporateActionsRequest¶
- class alpaca.data.requests.CorporateActionsRequest(*, symbols: List[str] | None = None, cusips: List[str] | None = None, types: List[CorporateActionsType] | None = None, start: date | None = None, end: date | None = None, ids: List[str] | None = None, limit: int | None = 1000, sort: Sort | None = Sort.ASC)¶
This request class is used to submit a request for corporate actions data. ref. https://docs.alpaca.markets/reference/corporateactions-1
- symbols¶
The list of ticker identifiers.
- Type:
Optional[List[str]]
- cusips¶
The list of CUSIPs.
- Type:
Optional[List[str]]
- types¶
The types of corporate actions to filter by. (default: all types)
- Type:
Optional[List[CorporateActionsType]]
- start¶
The inclusive start of the interval. Format: YYYY-MM-DD. (default: current day)
- Type:
Optional[date]
- end¶
The inclusive end of the interval. Format: YYYY-MM-DD. (default: current day)
- Type:
Optional[date])
- ids¶
The list of corporate action IDs. This parameter is mutually exclusive with all other filters (symbols, types, start, end).
- Type:
Optional[List[str]]
- limit¶
Upper limit of number of data points to return. (default: 1000)
- Type:
Optional[int]
- sort¶
The chronological order of response based on the timestamp. Defaults to ASC.
- Type:
Optional[Sort]