Get Scheduled Order

Use Case

Retrieve a single scheduled order by ID. The response returns the schedule under data.schedule with its current state, cadence, next execution time, and cumulative execution stats (total_executions, total_amount_spent, total_quantity_acquired).

Get Scheduled Order

Path Parameters

idUUIDRequired

Scheduled order identifier from Create Scheduled Order.

Response Fields

successBoolean

Top-level flag indicating the schedule was retrieved.

messageString

Human-readable status message.

data.scheduleObject

The schedule record. Fields mirror Create Scheduled Order's response plus cumulative execution stats.

data.schedule.idUUID

Schedule identifier.

data.schedule.company_idUUID

Company that owns the schedule.

data.schedule.currencyString

Asset being acquired on each tick (e.g. 'BTC').

data.schedule.quote_currencyString

Currency used to fund each tick (e.g. 'USDT').

data.schedule.amountString

Per-tick spend in the smallest unit of quote_currency.

data.schedule.frequencyString

'daily', 'weekly', or 'monthly'.

data.schedule.day_of_weekInteger

0–6 (Sunday=0) when frequency is 'weekly'; 0 otherwise.

data.schedule.day_of_monthInteger

1–31 when frequency is 'monthly'; 0 otherwise.

data.schedule.execution_timeString

24-hour HH:MM firing time in UTC.

data.schedule.statusString

'active', 'paused', 'cancelled', or 'completed'.

data.schedule.next_execution_atDate

Next scheduled run. Null when status is terminal.

data.schedule.last_executed_atString

Timestamp of the most recent execution. Empty string when the schedule has never fired.

data.schedule.total_executionsInteger

Number of ticks that have fired.

data.schedule.total_amount_spentString

Cumulative quote_currency spent across all executions.

data.schedule.total_quantity_acquiredString

Cumulative currency acquired across all executions.

data.schedule.created_atDate

When the schedule was created.

data.schedule.updated_atDate

When the schedule was last modified.

data.schedule.referenceString

Client-supplied idempotency key.

metadata.request_idString

Unique request identifier for support and tracing.

timestampDate

Server time when the response was generated.

Sample Response