Package markets.alpaca.client.data

Class StockTradesRequest.Builder

java.lang.Object

markets.alpaca.client.data.StockTradesRequest.Builder

Enclosing class:

StockTradesRequest

public static final class StockTradesRequest.Builder
extends Object

Builder for immutable StockTradesRequest instances.

Method Summary

Modifier and Type	Method	Description
StockTradesRequest.Builder	asof(String asof)	Applies symbol mapping as of a raw API date string.
StockTradesRequest.Builder	asof(LocalDate asof)	Applies symbol mapping as of the given date.
StockTradesRequest	build()	Builds and validates the immutable request.
StockTradesRequest.Builder	currency(String currency)	Requests prices in a supported local currency when enabled for the account.
StockTradesRequest.Builder	end(OffsetDateTime end)	Sets the exclusive end timestamp for historical trades.
StockTradesRequest.Builder	feed(StockHistoricalFeed feed)	Selects the historical stock data feed.
StockTradesRequest.Builder	limit(Integer limit)	Limits the number of returned trades.
StockTradesRequest.Builder	pageToken(String pageToken)	Continues from a next_page_token returned by a previous response.
StockTradesRequest.Builder	skipSymbolMapping()	Requests no symbol mapping by setting the API's asof=- sentinel.
StockTradesRequest.Builder	sort(Sort sort)	Sets chronological sort order for returned trades.
StockTradesRequest.Builder	start(OffsetDateTime start)	Sets the inclusive start timestamp for historical trades.
StockTradesRequest.Builder	symbols(String... symbols)	Sets the required symbols for the request.
StockTradesRequest.Builder	symbols(Collection<String> symbols)	Sets the required symbols for the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

symbols

public StockTradesRequest.Builder symbols(String... symbols)

Sets the required symbols for the request.

symbols

public StockTradesRequest.Builder symbols(Collection<String> symbols)

Sets the required symbols for the request.

start

public StockTradesRequest.Builder start(OffsetDateTime start)

Sets the inclusive start timestamp for historical trades.

end

public StockTradesRequest.Builder end(OffsetDateTime end)

Sets the exclusive end timestamp for historical trades.

limit

public StockTradesRequest.Builder limit(Integer limit)

Limits the number of returned trades. Must be positive when set.

asof

public StockTradesRequest.Builder asof(LocalDate asof)

Applies symbol mapping as of the given date.

asof

public StockTradesRequest.Builder asof(String asof)

Applies symbol mapping as of a raw API date string.

skipSymbolMapping

public StockTradesRequest.Builder skipSymbolMapping()

Requests no symbol mapping by setting the API's asof=- sentinel.

feed

public StockTradesRequest.Builder feed(StockHistoricalFeed feed)

Selects the historical stock data feed.

currency

public StockTradesRequest.Builder currency(String currency)

Requests prices in a supported local currency when enabled for the account.

pageToken

public StockTradesRequest.Builder pageToken(String pageToken)

Continues from a next_page_token returned by a previous response.

sort

public StockTradesRequest.Builder sort(Sort sort)

Sets chronological sort order for returned trades.

build

public StockTradesRequest build()

Builds and validates the immutable request.