Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

GET /api/optimisation/runs/:runId/paper-activity

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

  • Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

ParameterLocationType and requirement
runIdpathstring · required
limitquerystring · optional

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)
curl --include \
  --request GET \
  'https://api.weavers.app/api/optimisation/runs/1/paper-activity' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data
{
  "paperPeriodId": 1,
  "summary": {
    "openPositions": 1,
    "closedPositions": 1,
    "pendingOrders": 1,
    "failedOrders": 1,
    "skippedActions": 1,
    "openAnomalies": 1,
    "realizedPnl": 1,
    "openEntryNotional": 1,
    "lastActivityAt": null
  },
  "positions": [],
  "orderIntents": [],
  "fills": [],
  "skippedActions": [],
  "anomalies": [],
  "limit": 1,
  "truncated": {
    "positions": false,
    "orderIntents": false,
    "fills": false,
    "skippedActions": false,
    "anomalies": false
  }
}
View response model
paperPeriodId required · number
evidence optional · object
View evidence model
retrievedAt required · string
period required · null | object
View period model
Variant 1: null

null

Variant 2: object
startedAt required · string
endedAt required · null | string
View endedAt model
Variant 1: null

null

Variant 2: string

string

allocatedCapital required · null | number
View allocatedCapital model
Variant 1: null

null

Variant 2: number

number

providerId required · null | string
View providerId model
Variant 1: null

null

Variant 2: string

string

executionSource required · null | string
View executionSource model
Variant 1: null

null

Variant 2: string

string

executionState required · "blocked" | "queued" | "ended" | "paused" | "killed" | "enabled" | "unverified"
executionCheckedAt required · null | string
View executionCheckedAt model
Variant 1: null

null

Variant 2: string

string

pauseUntil required · null | string
View pauseUntil model
Variant 1: null

null

Variant 2: string

string

executionReason required · null | string
View executionReason model
Variant 1: null

null

Variant 2: string

string

queuePosition optional · null | number
View queuePosition model
Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

performance required · object
View performance model
status required · "available" | "unavailable" | "mismatch"
reason required · null | string
View reason model
Variant 1: null

null

Variant 2: string

string

snapshots required · array of object
View snapshots model

Array items:

day required · string
cash required · number
equity required · number
realizedPnl required · number
unrealizedPnl required · number
recordedAt required · string
source required · string

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

summary required · object
View summary model
openPositions required · number
closedPositions required · number
pendingOrders required · number
failedOrders required · number
skippedActions required · number
openAnomalies required · number
realizedPnl required · number
openEntryNotional required · number
lastActivityAt required · null | string
View lastActivityAt model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

positions required · array of object
View positions model

Array items:

id required · number
strategyTradeSignalId required · null | number
View strategyTradeSignalId model
Variant 1: null

null

Variant 2: number

number

symbol required · string
side required · string
status required · string
qty required · number
entryPrice required · null | number
View entryPrice model
Variant 1: null

null

Variant 2: number

number

entryReferencePrice required · null | number
View entryReferencePrice model
Variant 1: null

null

Variant 2: number

number

entryNotional required · null | number
View entryNotional model
Variant 1: null

null

Variant 2: number

number

stopLossPrice required · null | number
View stopLossPrice model
Variant 1: null

null

Variant 2: number

number

takeProfitPrice required · null | number
View takeProfitPrice model
Variant 1: null

null

Variant 2: number

number

openedAt required · null | string
View openedAt model
Variant 1: null

null

Variant 2: string

string

openedDay required · null | string
View openedDay model
Variant 1: null

null

Variant 2: string

string

exitPrice required · null | number
View exitPrice model
Variant 1: null

null

Variant 2: number

number

exitReason required · null | string
View exitReason model
Variant 1: null

null

Variant 2: string

string

realizedPnl required · null | number
View realizedPnl model
Variant 1: null

null

Variant 2: number

number

closedAt required · null | string
View closedAt model
Variant 1: null

null

Variant 2: string

string

closedDay required · null | string
View closedDay model
Variant 1: null

null

Variant 2: string

string

protectionMode required · null | "broker_bracket" | "weavers_managed"
View protectionMode model
Variant 1: null

null

Variant 2: "broker_bracket"

"broker_bracket"

Variant 3: "weavers_managed"

"weavers_managed"

protectionStatus required · null | "weavers_managed" | "broker_protected" | "protection_degraded" | "closed"
View protectionStatus model
Variant 1: null

null

Variant 2: "weavers_managed"

"weavers_managed"

Variant 3: "broker_protected"

"broker_protected"

Variant 4: "protection_degraded"

"protection_degraded"

Variant 5: "closed"

"closed"

entryClientOrderId required · null | string
View entryClientOrderId model
Variant 1: null

null

Variant 2: string

string

entryBrokerOrderId required · null | string
View entryBrokerOrderId model
Variant 1: null

null

Variant 2: string

string

exitClientOrderId required · null | string
View exitClientOrderId model
Variant 1: null

null

Variant 2: string

string

exitBrokerOrderId required · null | string
View exitBrokerOrderId model
Variant 1: null

null

Variant 2: string

string

signal required · null | object
View signal model
Variant 1: null

null

Variant 2: object
signalId required · null | number
View signalId model
Variant 1: null

null

Variant 2: number

number

tradingDay required · null | string
View tradingDay model
Variant 1: null

null

Variant 2: string

string

entryDay required · null | string
View entryDay model
Variant 1: null

null

Variant 2: string

string

entryAt required · null | string
View entryAt model
Variant 1: null

null

Variant 2: string

string

executionTimeframe required · null | string
View executionTimeframe model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

Additional fields: JSON values.

orderIntents required · array of object
View orderIntents model

Array items:

id required · number
strategyTradeSignalId required · null | number
View strategyTradeSignalId model
Variant 1: null

null

Variant 2: number

number

orderRole required · string
orderClass required · string
symbol required · string
side required · string
qty required · number
notional required · null | number
View notional model
Variant 1: null

null

Variant 2: number

number

timeInForce required · string
takeProfitLimitPrice required · null | number
View takeProfitLimitPrice model
Variant 1: null

null

Variant 2: number

number

stopLossStopPrice required · null | number
View stopLossStopPrice model
Variant 1: null

null

Variant 2: number

number

clientOrderId required · string
brokerOrderId required · null | string
View brokerOrderId model
Variant 1: null

null

Variant 2: string

string

status required · string
statusReason required · null | string
View statusReason model
Variant 1: null

null

Variant 2: string

string

attemptCount required · number
lastAttemptAt required · null | string
View lastAttemptAt model
Variant 1: null

null

Variant 2: string

string

submittedAt required · null | string
View submittedAt model
Variant 1: null

null

Variant 2: string

string

createdAt required · string
updatedAt required · string
signal required · null | object
View signal model
Variant 1: null

null

Variant 2: object
signalId required · null | number
View signalId model
Variant 1: null

null

Variant 2: number

number

tradingDay required · null | string
View tradingDay model
Variant 1: null

null

Variant 2: string

string

entryDay required · null | string
View entryDay model
Variant 1: null

null

Variant 2: string

string

entryAt required · null | string
View entryAt model
Variant 1: null

null

Variant 2: string

string

executionTimeframe required · null | string
View executionTimeframe model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

brokerOrders required · array of object
View brokerOrders model

Array items:

id required · number
paperOrderIntentId required · number
brokerOrderId required · string
clientOrderId required · null | string
View clientOrderId model
Variant 1: null

null

Variant 2: string

string

parentBrokerOrderId required · null | string
View parentBrokerOrderId model
Variant 1: null

null

Variant 2: string

string

orderLegRole required · string
symbol required · string
side required · string
qty required · number
status required · string
filledQty required · number
filledAvgPrice required · null | number
View filledAvgPrice model
Variant 1: null

null

Variant 2: number

number

submittedAt required · null | string
View submittedAt model
Variant 1: null

null

Variant 2: string

string

createdAt required · string
updatedAt required · string

Additional fields: JSON values.

Additional fields: JSON values.

fills required · array of object
View fills model

Array items:

id required · number
paperOrderIntentId required · number
brokerOrderId required · string
clientOrderId required · null | string
View clientOrderId model
Variant 1: null

null

Variant 2: string

string

brokerFillId required · string
orderLegRole required · string
symbol required · string
side required · string
qty required · number
price required · number
grossAmount required · null | number
View grossAmount model
Variant 1: null

null

Variant 2: number

number

cumulativeQty required · null | number
View cumulativeQty model
Variant 1: null

null

Variant 2: number

number

leavesQty required · null | number
View leavesQty model
Variant 1: null

null

Variant 2: number

number

transactionTime required · string
createdAt required · string
signal required · null | object
View signal model
Variant 1: null

null

Variant 2: object
signalId required · null | number
View signalId model
Variant 1: null

null

Variant 2: number

number

tradingDay required · null | string
View tradingDay model
Variant 1: null

null

Variant 2: string

string

entryDay required · null | string
View entryDay model
Variant 1: null

null

Variant 2: string

string

entryAt required · null | string
View entryAt model
Variant 1: null

null

Variant 2: string

string

executionTimeframe required · null | string
View executionTimeframe model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

Additional fields: JSON values.

skippedActions required · array of object
View skippedActions model

Array items:

id required · number
strategyTradeSignalId required · null | number
View strategyTradeSignalId model
Variant 1: null

null

Variant 2: number

number

actionDay required · string
actionType required · string
reasonCode required · string
reasonDetail required · null | string
View reasonDetail model
Variant 1: null

null

Variant 2: string

string

symbol required · null | string
View symbol model
Variant 1: null

null

Variant 2: string

string

createdAt required · string
signal required · null | object
View signal model
Variant 1: null

null

Variant 2: object
signalId required · null | number
View signalId model
Variant 1: null

null

Variant 2: number

number

tradingDay required · null | string
View tradingDay model
Variant 1: null

null

Variant 2: string

string

entryDay required · null | string
View entryDay model
Variant 1: null

null

Variant 2: string

string

entryAt required · null | string
View entryAt model
Variant 1: null

null

Variant 2: string

string

executionTimeframe required · null | string
View executionTimeframe model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

Additional fields: JSON values.

anomalies required · array of object
View anomalies model

Array items:

id required · number
severity required · string
anomalyCode required · string
entityType required · string
entityId required · null | string
View entityId model
Variant 1: null

null

Variant 2: string

string

status required · string
firstSeenAt required · string
lastSeenAt required · string
resolvedAt required · null | string
View resolvedAt model
Variant 1: null

null

Variant 2: string

string

occurrenceCount required · number

Additional fields: JSON values.

limit required · number
truncated required · object
View truncated model
positions required · boolean
orderIntents required · boolean
fills required · boolean
skippedActions required · boolean
anomalies required · boolean

Additional fields: JSON values.

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{
  "error": "example",
  "code": "example"
}
View response model
error required · string
code required · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

404 · Resource or enabled capability not found.

application/json

404 example · synthetic data
{
  "error": "example",
  "code": "example"
}
View response model
error required · string
code required · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data
{
  "error": "example",
  "code": "example"
}
View response model
error required · string
code required · string

Additional fields: JSON values.