Package markets.alpaca.client.trading

Class ListOrdersRequest.Builder

java.lang.Object

markets.alpaca.client.trading.ListOrdersRequest.Builder

Enclosing class:

ListOrdersRequest

public static final class ListOrdersRequest.Builder
extends Object

Builder for immutable ListOrdersRequest instances.

Method Summary

Modifier and Type	Method	Description
ListOrdersRequest.Builder	after(String after)	Returns orders submitted after this raw RFC 3339 timestamp string.
ListOrdersRequest.Builder	after(OffsetDateTime after)	Returns orders submitted after this timestamp.
ListOrdersRequest.Builder	afterOrderId(String afterOrderId)	Starts order-id pagination after the supplied order id.
ListOrdersRequest.Builder	assetClasses(String... assetClasses)	Filters by raw asset class values supported by the Trading API.
ListOrdersRequest.Builder	assetClasses(Collection<String> assetClasses)	Filters by raw asset class values supported by the Trading API.
ListOrdersRequest.Builder	assetClasses(AssetClass... assetClasses)	Filters by asset class using generated Trading model enum values.
ListOrdersRequest.Builder	beforeOrderId(String beforeOrderId)	Starts order-id pagination before the supplied order id.
ListOrdersRequest	build()	Builds and validates the immutable request.
ListOrdersRequest.Builder	direction(String direction)	Sets the raw result sort direction accepted by the Trading API.
ListOrdersRequest.Builder	direction(ListOrdersRequest.Direction direction)	Sets the result sort direction.
ListOrdersRequest.Builder	limit(Integer limit)	Limits the number of returned orders.
ListOrdersRequest.Builder	nested(Boolean nested)	Includes nested multi-leg order details when supported by the endpoint.
ListOrdersRequest.Builder	side(String side)	Filters by a raw order side value supported by the Trading API.
ListOrdersRequest.Builder	side(OrderSide side)	Filters by order side using the generated Trading model enum.
ListOrdersRequest.Builder	status(String status)	Filters by a raw status value supported by the Trading API.
ListOrdersRequest.Builder	status(ListOrdersRequest.Status status)	Filters by the documented order status values: open, closed, or all.
ListOrdersRequest.Builder	symbols(String... symbols)	Filters to one or more symbols, encoded as the comma-separated parameter expected by the API.
ListOrdersRequest.Builder	symbols(Collection<String> symbols)	Filters to one or more symbols, encoded as the comma-separated parameter expected by the API.
ListOrdersRequest.Builder	symbolsCsv(String symbols)	Sets a raw comma-separated symbol filter string.
ListOrdersRequest.Builder	until(String until)	Returns orders submitted until this raw RFC 3339 timestamp string.
ListOrdersRequest.Builder	until(OffsetDateTime until)	Returns orders submitted until this timestamp.

Methods inherited from class java.lang.Object

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

Method Details

status

public ListOrdersRequest.Builder status(ListOrdersRequest.Status status)

Filters by the documented order status values: open, closed, or all.

status

public ListOrdersRequest.Builder status(String status)

Filters by a raw status value supported by the Trading API.

limit

public ListOrdersRequest.Builder limit(Integer limit)

Limits the number of returned orders. The Trading API accepts values from 1 through 500.

after

public ListOrdersRequest.Builder after(OffsetDateTime after)

Returns orders submitted after this timestamp. Cannot be combined with order-id pagination.

after

public ListOrdersRequest.Builder after(String after)

Returns orders submitted after this raw RFC 3339 timestamp string.

until

public ListOrdersRequest.Builder until(OffsetDateTime until)

Returns orders submitted until this timestamp. Cannot be combined with order-id pagination.

until

public ListOrdersRequest.Builder until(String until)

Returns orders submitted until this raw RFC 3339 timestamp string.

direction

public ListOrdersRequest.Builder direction(ListOrdersRequest.Direction direction)

Sets the result sort direction.

direction

public ListOrdersRequest.Builder direction(String direction)

Sets the raw result sort direction accepted by the Trading API.

nested

public ListOrdersRequest.Builder nested(Boolean nested)

Includes nested multi-leg order details when supported by the endpoint.

symbols

public ListOrdersRequest.Builder symbols(String... symbols)

Filters to one or more symbols, encoded as the comma-separated parameter expected by the API.

symbols

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

Filters to one or more symbols, encoded as the comma-separated parameter expected by the API.

symbolsCsv

public ListOrdersRequest.Builder symbolsCsv(String symbols)

Sets a raw comma-separated symbol filter string.

side

public ListOrdersRequest.Builder side(OrderSide side)

Filters by order side using the generated Trading model enum.

side

public ListOrdersRequest.Builder side(String side)

Filters by a raw order side value supported by the Trading API.

assetClasses

public ListOrdersRequest.Builder assetClasses(AssetClass... assetClasses)

Filters by asset class using generated Trading model enum values.

assetClasses

public ListOrdersRequest.Builder assetClasses(String... assetClasses)

Filters by raw asset class values supported by the Trading API.

assetClasses

public ListOrdersRequest.Builder assetClasses(Collection<String> assetClasses)

Filters by raw asset class values supported by the Trading API.

beforeOrderId

public ListOrdersRequest.Builder beforeOrderId(String beforeOrderId)

Starts order-id pagination before the supplied order id.

afterOrderId

public ListOrdersRequest.Builder afterOrderId(String afterOrderId)

Starts order-id pagination after the supplied order id.

build

public ListOrdersRequest build()

Builds and validates the immutable request.