GET /api/eureka/research/inspection

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
`nicheId`	query	string · optional
`nicheKey`	query	string · optional
`provider`	query	string · required
`source`	query	string · optional
`country`	query	string · optional
`geography`	query	string · optional
`instrumentType`	query	string · optional
`theme`	query	string · optional
`sectors`	query	string · optional
`exchanges`	query	string · optional
`themes`	query	string · optional
`startDate`	query	string · required
`endDate`	query	string · required
`timeframe`	query	string · required
`equitiesOnly`	query	string · optional
`excludeEtfs`	query	string · optional
`excludeIndiaEtfs`	query	string · optional
`symbol`	query	string · optional
`benchmarkSymbol`	query	string · optional
`search`	query	string · optional
`offset`	query	string · optional
`overviewOnly`	query	string · optional
`predictor`	query	string · optional
`previewOnly`	query	string · optional
`predictorOnly`	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/eureka/research/inspection?provider=github&startDate=2025-01-01&endDate=2025-06-30&timeframe=example' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "dataset": {
    "provider": "alpaca",
    "startDate": "2025-01-01",
    "endDate": "2025-06-30",
    "timeframe": "1D",
    "nicheId": 1,
    "nicheKey": "example",
    "equitiesOnly": false,
    "excludeEtfs": false,
    "excludeIndiaEtfs": false
  },
  "inspectedAt": "2025-01-01T00:00:00.000Z",
  "assets": [],
  "assetCount": 1,
  "assetsTruncated": false,
  "symbol": null,
  "candles": [],
  "rejectedRows": 1,
  "candlesTruncated": false
}

View response model

previewAssetOffset optional · number

previewWithData optional · number

predictorSeries optional · array of object

View predictorSeries model

Array items:

timestamp required · string

value required · null | number

View value model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

dataset required · object

View dataset model

Variant 1: object

provider required · "alpaca" | "marketstack"

startDate required · string

endDate required · string

timeframe required · "1D" | "1H"

nicheId required · number

nicheKey required · string

equitiesOnly required · boolean

excludeEtfs required · boolean

excludeIndiaEtfs required · boolean

Additional fields: JSON values.

Variant 2: object

provider required · "alpaca" | "marketstack"

startDate required · string

endDate required · string

timeframe required · "1D" | "1H"

source required · "catalog"

country required · string

geography required · "exposure" | "listing"

instrumentType required · "other" | "stock" | "etf"

theme optional · string

Additional fields: JSON values.

inspectedAt required · string

assets required · array of object

View assets model

Array items:

symbol required · string

name required · string

sector optional · null | string

View sector model

Variant 1: null

null

Variant 2: string

string

exchange optional · null | string

View exchange model

Variant 1: null

null

Variant 2: string

string

currency optional · null | string

View currency model

Variant 1: null

null

Variant 2: string

string

country optional · null | string

View country model

Variant 1: null

null

Variant 2: string

string

assetType optional · null | string

View assetType model

Variant 1: null

null

Variant 2: string

string

listingCountry optional · null | string

View listingCountry model

Variant 1: null

null

Variant 2: string

string

exposureCountry optional · null | string

View exposureCountry model

Variant 1: null

null

Variant 2: string

string

exposureBasis optional · null | string

View exposureBasis model

Variant 1: null

null

Variant 2: string

string

priceSummary optional · object

View priceSummary model

high required · null | number

View high model

Variant 1: null

null

Variant 2: number

number

low required · null | number

View low model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

priceHistory optional · array of object

View priceHistory model

Array items:

time required · string

close required · number

Additional fields: JSON values.

coverage optional · object

View coverage model

bars required · number

first required · null | string

View first model

Variant 1: null

null

Variant 2: string

string

last required · null | string

View last model

Variant 1: null

null

Variant 2: string

string

source required · null | string

View source model

Variant 1: null

null

Variant 2: string

string

referenceBars required · number

missingBars required · number

missingVolume required · number

invalidBars required · number

adjustedCloseBars required · number

status required · "matches_reference" | "partial" | "no_data" | "unknown_exchange"

Additional fields: JSON values.

assetCount required · number

assetsTruncated required · boolean

symbol required · null | string

View symbol model

Variant 1: null

null

Variant 2: string

string

candles required · array of object

View candles model

Array items:

timestamp required · string

open required · number

high required · number

low required · number

close required · number

volume optional · number

Additional fields: JSON values.

rejectedRows required · number

candlesTruncated required · boolean

overview optional · object

View overview model

marketCapAssets optional · array of object

View marketCapAssets model

Array items:

symbol required · string

name required · string

coverage optional · object

View coverage model

bars required · number

first required · null | string

View first model

Variant 1: null

null

Variant 2: string

string

last required · null | string

View last model

Variant 1: null

null

Variant 2: string

string

source required · null | string

View source model

Variant 1: null

null

Variant 2: string

string

referenceBars required · number

missingBars required · number

missingVolume required · number

invalidBars required · number

adjustedCloseBars required · number

status required · "matches_reference" | "partial" | "no_data" | "unknown_exchange"

Additional fields: JSON values.

sector optional · null | string

View sector model

Variant 1: null

null

Variant 2: string

string

assetType optional · null | string

View assetType model

Variant 1: null

null

Variant 2: string

string

priceHistory optional · array of object

View priceHistory model

Array items:

time required · string

close required · number

Additional fields: JSON values.

priceSummary optional · object

View priceSummary model

high required · null | number

View high model

Variant 1: null

null

Variant 2: number

number

low required · null | number

View low model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

currency optional · null | string

View currency model

Variant 1: null

null

Variant 2: string

string

exchange optional · null | string

View exchange model

Variant 1: null

null

Variant 2: string

string

listingCountry optional · null | string

View listingCountry model

Variant 1: null

null

Variant 2: string

string

marketCap required · null | number

View marketCap model

Variant 1: null

null

Variant 2: number

number

marketCapCurrency required · null | string

View marketCapCurrency model

Variant 1: null

null

Variant 2: string

string

marketCapAsOf required · null | string

View marketCapAsOf model

Variant 1: null

null

Variant 2: string

string

marketCapEstimated optional · false | true

marketCapSharesOutstanding optional · null | number

View marketCapSharesOutstanding model

Variant 1: null

null

Variant 2: number

number

marketCapSharesAsOf optional · null | string

View marketCapSharesAsOf model

Variant 1: null

null

Variant 2: string

string

marketCapSharesFiledAt optional · null | string

View marketCapSharesFiledAt model

Variant 1: null

null

Variant 2: string

string

marketCapSharesAccession optional · null | string

View marketCapSharesAccession model

Variant 1: null

null

Variant 2: string

string

marketCapPriceSource optional · null | string

View marketCapPriceSource model

Variant 1: null

null

Variant 2: string

string

marketCapValidUntil optional · null | string

View marketCapValidUntil model

Variant 1: null

null

Variant 2: string

string

marketCapFetchedAt optional · null | string

View marketCapFetchedAt model

Variant 1: null

null

Variant 2: string

string

marketCapProvider optional · null | string

View marketCapProvider model

Variant 1: null

null

Variant 2: string

string

marketCapValuationPrecision optional · null | "date" | "timestamp"

View marketCapValuationPrecision model

Variant 1: null

null

Variant 2: "date"

"date"

Variant 3: "timestamp"

"timestamp"

marketCapStatus optional · "stale" | "missing" | "fresh" | "undated"

Additional fields: JSON values.

filteredCount required · number

offset required · number

pageSize required · number

withData required · number

matchesReference required · number

sectors required · array of object

View sectors model

Array items:

label required · string

count required · number

Additional fields: JSON values.

exchanges required · array of object

View exchanges model

Array items:

label required · string

count required · number

Additional fields: JSON values.

currencies required · array of object

View currencies model

Array items:

label required · string

count required · number

Additional fields: JSON values.

selectedAsset optional · object

View selectedAsset model

symbol required · string

name required · string

sector optional · null | string

View sector model

Variant 1: null

null

Variant 2: string

string

exchange optional · null | string

View exchange model

Variant 1: null

null

Variant 2: string

string

currency optional · null | string

View currency model

Variant 1: null

null

Variant 2: string

string

country optional · null | string

View country model

Variant 1: null

null

Variant 2: string

string

assetType optional · null | string

View assetType model

Variant 1: null

null

Variant 2: string

string

listingCountry optional · null | string

View listingCountry model

Variant 1: null

null

Variant 2: string

string

exposureCountry optional · null | string

View exposureCountry model

Variant 1: null

null

Variant 2: string

string

exposureBasis optional · null | string

View exposureBasis model

Variant 1: null

null

Variant 2: string

string

priceSummary optional · object

View priceSummary model

high required · null | number

View high model

Variant 1: null

null

Variant 2: number

number

low required · null | number

View low model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

priceHistory optional · array of object

View priceHistory model

Array items:

time required · string

close required · number

Additional fields: JSON values.

coverage optional · object

View coverage model

bars required · number

first required · null | string

View first model

Variant 1: null

null

Variant 2: string

string

last required · null | string

View last model

Variant 1: null

null

Variant 2: string

string

source required · null | string

View source model

Variant 1: null

null

Variant 2: string

string

referenceBars required · number

missingBars required · number

missingVolume required · number

invalidBars required · number

adjustedCloseBars required · number

status required · "matches_reference" | "partial" | "no_data" | "unknown_exchange"

Additional fields: JSON values.

benchmark optional · object

View benchmark model

symbol required · string

currency required · null | string

View currency model

Variant 1: null

null

Variant 2: string

string

source required · null | string

View source model

Variant 1: null

null

Variant 2: string

string

candles required · array of object

View candles model

Array items:

timestamp required · string

open required · number

high required · number

low required · number

close required · number

volume optional · number

Additional fields: JSON values.

truncated required · boolean

status required · "ready" | "unavailable"

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.

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

{}

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.

502 · Dependency failure.

application/json

502 example · synthetic data

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.