GET /api/optimisation/strategy-niches

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

Parameter	Location	Type and requirement
`limit`	query	string · 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/strategy-niches' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "niches": []
}

View response model

niches required · array of object

View niches model

Array items:

nicheId required · number

nicheKey required · null | string

View nicheKey model

Variant 1: null

null

Variant 2: string

string

displayName required · string

source required · "platform" | "publish" | "legacy"

visibility required · "private" | "public" | "hidden"

strategyKey required · null | string

View strategyKey model

Variant 1: null

null

Variant 2: string

string

universeFilterKey required · null | string

View universeFilterKey model

Variant 1: null

null

Variant 2: string

string

targetRegime required · null | string

View targetRegime model

Variant 1: null

null

Variant 2: string

string

assetType required · null | string

View assetType model

Variant 1: null

null

Variant 2: string

string

countryCode required · null | string

View countryCode model

Variant 1: null

null

Variant 2: string

string

exchange required · null | string

View exchange model

Variant 1: null

null

Variant 2: string

string

themeTags required · array of string

View themeTags model

Array items:

string

metadataFilter required · object

View metadataFilter model

Additional fields: JSON value.

membershipKind required · "static" | "channel_episode"

description required · null | string

View description model

Variant 1: null

null

Variant 2: string

string

createdAt required · null | string

View createdAt model

Variant 1: null

null

Variant 2: string

string

assetCount required · null | number

View assetCount model

Variant 1: null

null

Variant 2: number

number

profiledAssetCount required · null | number

View profiledAssetCount model

Variant 1: null

null

Variant 2: number

number

assetCoverageStatus required · null | "ready" | "empty" | "incomplete_profiles"

View assetCoverageStatus model

Variant 1: null

null

Variant 2: "ready"

"ready"

Variant 3: "empty"

"empty"

Variant 4: "incomplete_profiles"

"incomplete_profiles"

strategyCount required · number

strategies required · array of object

View strategies model

Array items:

strategyRegistryId required · number

strategyId required · string

title required · string

alias required · null | string

View alias model

Variant 1: null

null

Variant 2: string

string

strategyKey required · string

strategyVariant required · string

artifactId required · number

artifactVersion required · string

sourceRunId required · null | string

View sourceRunId model

Variant 1: null

null

Variant 2: string

string

publishedAt required · null | string

View publishedAt model

Variant 1: null

null

Variant 2: string

string

updatedAt required · null | string

View updatedAt model

Variant 1: null

null

Variant 2: string

string

lifecycleStatus required · null | string

View lifecycleStatus model

Variant 1: null

null

Variant 2: string

string

lifecycleReasonCode required · null | string

View lifecycleReasonCode model

Variant 1: null

null

Variant 2: string

string

entryMode required · null | "created_new_niche" | "joined_existing_niche"

View entryMode model

Variant 1: null

null

Variant 2: "created_new_niche"

"created_new_niche"

Variant 3: "joined_existing_niche"

"joined_existing_niche"

currentOutcome required · null | "failed" | "promoted" | "withdrawn" | "in_progress"

View currentOutcome model

Variant 1: null

null

Variant 2: "failed"

"failed"

Variant 3: "promoted"

"promoted"

Variant 4: "withdrawn"

"withdrawn"

Variant 5: "in_progress"

"in_progress"

forkDepth required · number

parentStrategyRegistryId required · null | number

View parentStrategyRegistryId model

Variant 1: null

null

Variant 2: number

number

parentStrategyId required · null | string

View parentStrategyId model

Variant 1: null

null

Variant 2: string

string

stress required · object

View stress model

stressTestId required · null | number

View stressTestId model

Variant 1: null

null

Variant 2: number

number

promotionSharpe required · null | number

View promotionSharpe model

Variant 1: null

null

Variant 2: number

number

failedGateNames required · array of string

View failedGateNames model

Array items:

string

monteCarloPValue required · null | number

View monteCarloPValue model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

paper required · object

View paper model

paperPeriodId required · null | number

View paperPeriodId model

Variant 1: null

null

Variant 2: number

number

execution optional · object

View execution model

executionSource required · null | "broker_backed" | "internal_simulation"

View executionSource model

Variant 1: null

null

Variant 2: "broker_backed"

"broker_backed"

Variant 3: "internal_simulation"

"internal_simulation"

brokerReadinessStatus required · null | "blocked" | "ready" | "queued"

View brokerReadinessStatus model

Variant 1: null

null

Variant 2: "blocked"

"blocked"

Variant 3: "ready"

"ready"

Variant 4: "queued"

"queued"

providerId required · null | string

View providerId model

Variant 1: null

null

Variant 2: string

string

connectMode required · null | "api_key" | "oauth"

View connectMode model

Variant 1: null

null

Variant 2: "api_key"

"api_key"

Variant 3: "oauth"

"oauth"

brokerAccountId required · null | string

View brokerAccountId model

Variant 1: null

null

Variant 2: string

string

blockedReasonCode required · null | string

View blockedReasonCode model

Variant 1: null

null

Variant 2: string

string

readyAt required · null | string

View readyAt model

Variant 1: null

null

Variant 2: string

string

skippedActionCount optional · null | number

View skippedActionCount model

Variant 1: null

null

Variant 2: number

number

skippedActionDays optional · array of string

View skippedActionDays model

Array items:

string

protection optional · null | object

View protection model

Variant 1: null

null

Variant 2: object

brokerBracketOpenPositions required · number

weaversManagedOpenPositions required · number

protectionDegradedOpenPositions required · number

Additional fields: JSON values.

outcome required · null | "failed" | "promoted" | "withdrawn"

View outcome model

Variant 1: null

null

Variant 2: "failed"

"failed"

Variant 3: "promoted"

"promoted"

Variant 4: "withdrawn"

"withdrawn"

elapsedTradingDays required · null | number

View elapsedTradingDays model

Variant 1: null

null

Variant 2: number

number

requiredDays required · null | number

View requiredDays model

Variant 1: null

null

Variant 2: number

number

paperSharpe required · null | number

View paperSharpe model

Variant 1: null

null

Variant 2: number

number

requiredPaperSharpe required · null | number

View requiredPaperSharpe model

Variant 1: null

null

Variant 2: number

number

tradeCount required · null | number

View tradeCount model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

live required · object

View live model

activeDeploymentCount required · number

Additional fields: JSON values.

400 · Invalid request.

application/json

400 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.

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.

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

{
  "error": "example",
  "code": "example"
}

View response model

error required · string

code required · string

Additional fields: JSON values.