GET /api/niches

Public access · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Request

Parameter	Location	Type and requirement
`regime`	query	string · optional
`assetType`	query	string · optional
`country`	query	string · optional
`exchange`	query	string · optional
`limit`	query	string · optional Defaults to 200; values above 500 are capped at 500. Pattern: `^[1-9][0-9]{0,8}$`

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/niches'

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 · string

visibility required · string

targetRegime required · null | string

View targetRegime model

Variant 1: null

null

Variant 2: string

string

membershipKind required · "static" | "channel_episode"

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

certifiedCount required · number

liveCount required · number

medianDailyDollarVolume required · null | number

View medianDailyDollarVolume model

Variant 1: null

null

Variant 2: number

number

realizedVolatility required · null | number

View realizedVolatility model

Variant 1: null

null

Variant 2: number

number

crossSectionalDispersion required · null | number

View crossSectionalDispersion model

Variant 1: null

null

Variant 2: number

number

historyDepthDays required · null | number

View historyDepthDays model

Variant 1: null

null

Variant 2: number

number

pricedConstituentCount required · null | number

View pricedConstituentCount model

Variant 1: null

null

Variant 2: number

number

metricsAsOfDate required · null | string

View metricsAsOfDate model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{
  "error": "example"
}

View response model

error 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

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.