MerQube Index API
APIs for MerQube Indices
MerQube Index API is one of 9 APIs that MerQube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Index. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.
This API exposes 27 operations across 17 paths, and defines 147 schemas. It is described by OpenAPI 3.2.0, at version 4.40.0.
Requests are made against 3 base URLs: https://api.merqube.com, https://api.staging.merqube.com, https://staging.api.merqube.com.
27 operations
17 paths
147 schemas
4 DELETE15 GET2 PATCH2 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 27
Across 17 paths, the API surfaces 27 operations — 4 DELETE, 15 GET, 2 PATCH, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
index 27
APIs for MerQube Indices
GET
/index
Get all MerQube indices.
POST
/index
Create a new MerQube index
DELETE
/index-documents
Delete an identifier from an index
GET
/index-documents
List of index documents
PUT
/index-documents
Upload a document for an index
DELETE
/index/{uuid}
Delete a MerQube index.
GET
/index/{uuid}
Returns the MerQube index with this uuid
PATCH
/index/{uuid}
Partially update a MerQube index
PUT
/index/{uuid}
Replace a MerQube index
GET
/index/{uuid}/caps
Get the caps of buffer MerQube index
GET
/index/{uuid}/data_collections
get the timeseries of data collections for an index
PUT
/index/{uuid}/data_collections
create or replace the data collection specification for this index
GET
/index/{uuid}/data_collections/data
fetch the data collections from s3
GET
/index/{uuid}/data_collections/raw
Get a presigned raw file redirect for s3
GET
/index/{uuid}/documents
Get documentation for an index
GET
/index/{uuid}/portfolio
Get the portfolio of a MerQube index over time
GET
/index/{uuid}/portfolio_allocations
Get the allocations of a MerQube index
GET
/index/{uuid}/run_state
get the latest run state of the index. May be enhanced in the future to support quering for a given effts (e.g., historically).
GET
/index/{uuid}/stats
Returns stats associated with a specific MerQube index
GET
/index/{uuid}/stats2
Returns stats associated with a specific MerQube index
GET
/index/{uuid}/target_portfolio
get the timeseries of target portfolios for an index
PUT
/index/{uuid}/target_portfolio
replace the portfolio for this index. Will eventually but not immediately affect /index/uuid/portfolio.
DELETE
/index/{uuid}/target_portfolio/{target_portfolio_uuid}
Deletes an existing target portfolio
GET
/index/{uuid}/target_portfolio/{target_portfolio_uuid}
Get an existing target portfolio
PATCH
/index/{uuid}/target_portfolio/{target_portfolio_uuid}
Update an existing target portfolio
POST
index/{uuid}/identifier/{provider}
Add an identifier to an index
DELETE
index/{uuid}/identifier/{provider}/{identifier_name}
Delete an identifier from an index
Schemas 147
The contract defines 147 schemas that model the data the API accepts and returns. The most detailed are IndexDefinitionPost (42 properties), IndexDefinitionPost_2 (40 properties), OptionSpecific (17 properties), RunConfig (15 properties). Each schema is shown below with its type and property counts.
PortfolioUom
string
Used to indicate if portfolio amounts are absolute or relative. weight indicates portfolio amounts are relative weights units indicates portfolio amounts are a…
MetricsSchema
object
4 properties
3 required
CrudExtra
object
3 properties
3 required
BasketPortfolioRaw
object
Target Portfolio. Supports equities, futures, and options. This object captures all information needed to execute externally defined rebalances. This is the ra…
FsymEquityPosition
Equity position, identified by a FSYM + country code
IdentifierUUIDPost
object
Identifier for a given provider. Will be referenced via the name field of the Identifier section
11 properties
3 required
LevelCheck
object
2 required
holidays_to_add
object
1 property
IndexDefinitionPatchPutGet
object
Provider
string
currently supported providers
BloombergProviderKwargsPostType
string
How to post the data to Bloomberg, either the end of day method (EOD), real time method (RT) or both (EODANDRT)
PortfolioStatus
string
Indicates the status of a target portfolio. A portfolio can only be used in an index if status is FINAL PENDINGVALIDATION - Custom validation is necessary, and…
SecapiBasketPosition
A basket position that uses custom metrics from merqube data source
HolidayCalendarSpec
HistoryCheck
object
2 required
CountryCode
string
ISO country codes
OptionPosition
An Option position
IntradayFlatlineAlerts
object
5 properties
RicEquityPosition
Equity position, identified by a RIC
ArgumentsOrEnvVars
array
Administrative
object
3 properties
1 required
RebalFrequency
string
SecapiProviderKwargs
object
Secapi provider custom arguments
3 properties
3 required
StatsRequest
object
6 properties
1 required
IntradayTickFilter
object
Filter for tick events, used to configure when an rtindex should process ticks or send ticks to targets
6 properties
IsoTS
string
PercentChangeCheck
object
2 required
IntradayPublishConfigReutersTargetParams
object
3 properties
FsymSpecific
object
1 property
1 required
IntradayPublishConfigWrapper
object
oneOfs at the top level of an object lead to hard to work with RootModels in pydantic. Forming this one property object makes importing and passing around this…
1 property
IndexReport
object
4 properties
1 required
CopyFromManifest
object
Creates a new resource by starting from an existing resource, removing the id/status, adding/updating/deleting keys, then posting it as a new resource. The ori…
4 properties
2 required
OptionStyle
string
Webpage
object
2 properties
BloombergProviderKwargs
object
Bloomberg provider custom arguments
1 property
1 required
ListDataCollections
object
1 property
HistoryCheckParams
object
1 property
1 required
IndexIdentifierUUIDPost
object
CalculationCheck
array
SubPod
object
6 properties
3 required
DqmsConfig
object
1 property
FreezerConfig
object
5 properties
Deadline
object
6 properties
5 required
RicSpecific
object
3 properties
SecapiSpecific
object
1 property
AssetType
string
calendar_identifiers
object
1 property
NotificationConfig
object
3 properties
IndexSpec
object
4 properties
1 required
AlertHours
object
2 properties
RunConfigLabel
object
Intraday
NestedCalendarSchema
object
3 properties
2 required
IdentifierUUIDRef
object
maps to an identifier resource
3 properties
2 required
IsoDate
string
RunConfig
object
15 properties
3 required
IntradayPublishConfigSecapiTarget
BasketPortfolioPutIn
object
Input data for creating/replacing target portfolios. This object captures all information needed to execute externally defined rebalances.
7 properties
3 required
MetricResult
object
2 properties
Stats
object
8 properties
RunState
object
3 properties
1 required
PositionIdentifierType
string
OptionType
string
IntradayPublishConfigTargetBase
object
1 property
IntradayPublishConfigDbTarget
OptionSpecific
object
17 properties
6 required
IntradayPublishConfigBloombergTargetParams
object
2 properties
IntradayInfraTimedScaling
object
Describes how to scale up and down based on the active time range.
3 properties
CustomCharts
object
8 properties
3 required
BasketPortfolioPatchIn
object
Input data for updating an existing target portfolio
2 properties
Status
object
5 properties
1 required
DisseminationDestinations
object
3 properties
DataCollectionsSpec
object
schema for data collections
10 properties
3 required
LevelCheckParams
object
2 properties
2 required
IntradayPublishConfigBloombergTarget
MerqubeIndexSpecific
object
1 property
FlatCalendarSchema
object
6 properties
StatsResponse
object
1 property
IntradayPublishConfig
object
Mapping of index metric to targets it should be sent to
ReutersProviderKwargs
object
Reuters provider custom arguments
1 property
IntradayPublishConfigReutersTarget
ValidEquityBasketPosition
BasketPortfolio
object
Target Portfolio. Supports equities, futures, and options. This object captures all information needed to execute externally defined rebalances.
Related
object
5 properties
3 required
RunConfigLabelAdditional
object
used when there needs to be different run configurations, each with a different label, such as 'initial' vs 'final'
1 property
1 required
BasketPosition
object
A general basket portfolio position
5 properties
4 required
Schedule
object
9 properties
3 required
ReutersProviderKwargsPostType
string
How to post the data to Reuters, either the end of day method (EOD), real time method (RT) or both (EODANDRT)
FuturesPosition
A Futures position
IndexBenchmark
object
4 properties
2 required
AirflowConfig
object
7 properties
MerqubeIndexPosition
A basket position that uses custom metrics from merqube data source
RealTimeTradeType
Trade types that can be used for real time quotes. Examples of ineligible trade types are dark pool and odd lot trades.
NasdaqProviderKwargs
object
Nasdaq provider custom arguments
2 properties
1 required
IndexDefinitionPost
object
42 properties
6 required
PercentChangeCheckParams
object
2 properties
2 required
BaseDate
string
the date that the index has level 'basevalue'
IntradayAlerting
object
Alerting configuration for intraday ticks
1 property
OptionExpirationType
string
FuturesSpecific
object
7 properties
4 required
ErrorCodes
object
2 properties
IntradayAlertType
string
BaseCheck
object
3 properties
2 required
RunStateStatus
string
the state of the last index run, if applicable
S3Bucket
object
2 properties
1 required
MerqTimestamp
IsoTS_2
string
IsoDate_2
string
BaseDate_2
string
the date that the index has level 'basevalue'
CrudExtra_2
object
3 properties
3 required
LevelCheck_2
object
Provider_2
string
currently supported providers
HistoryCheck_2
object
CountryCode_2
string
ISO country codes
IntradayTickFilter_2
object
Filter for tick events, used to configure when an rtindex should process ticks or send ticks to targets
6 properties
IsoTS_3
string
PercentChangeCheck_2
object
OptionStyle_2
string
HistoryCheckParams_2
object
1 property
1 required
AssetType_2
string
IndexSpec_2
object
4 properties
RunConfigLabel_2
object
Intraday_2
IsoDate_3
string
RunConfig_2
object
13 properties
3 required
IntradayPublishConfigSecapiTarget_2
BasketPortfolioPutIn_2
object
Input data for creating/replacing target portfolios. This object captures all information needed to execute externally defined rebalances.
6 properties
3 required
PositionIdentifierType_2
string
OptionType_2
string
IntradayPublishConfigDbTarget_2
OptionSpecific_2
object
15 properties
6 required
LevelCheckParams_2
object
2 properties
2 required
IntradayPublishConfigBloombergTarget_2
IntradayPublishConfigReutersTarget_2
BasketPortfolio_2
object
Target Portfolio. Supports equities, futures, and options. This object captures all information needed to execute externally defined rebalances.
BasketPosition_2
object
A general basket portfolio position
5 properties
4 required
Schedule_2
object
7 properties
3 required
ReutersProviderKwargsPostType_2
string
How to post the data to Reuters, either the end of day method (EOD), real time method (RT) or both (EODANDRT)
IndexBenchmark_2
object
4 properties
2 required
AirflowConfig_2
object
6 properties
RealTimeTradeType_2
string
Trade types that can be used for real time quotes. Examples of ineligible trade types are dark pool and odd lot trades.
IndexDefinitionPost_2
object
40 properties
7 required
PercentChangeCheckParams_2
object
2 properties
2 required
BaseDate_3
string
the date that the index has level 'basevalue'
OptionExpirationType_2
string
FuturesSpecific_2
object
7 properties
3 required
MerqTimestamp_2
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MerQube 8
Other APIs MerQube publishes across the network.
MerQube API
MerQube Helper API
MerQube Identifier API
MerQube Legacy Equity Security API
MerQube Options API
MerQube Portfolio Handler API
MerQube Security API
MerQube Security List API
#Index
Where this information came from
This is an independent, third-party profile of MerQube Index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.