Paths on this page are relative to /api/liquidity-studio/v2. Authentication and required headers vary by operation.
API reference overview · OpenAPI download
Operations on this page#
| Method | Path | Operation |
|---|---|---|
GET |
/scores |
listScores |
POST |
/scores |
createScores |
GET |
/scores/{id} |
getScores |
GET |
/attributions |
listAttributions |
POST |
/attributions |
createAttributions |
GET |
/attributions/{id} |
getAttributions |
GET |
/anomalies |
listAnomalies |
POST |
/anomalies |
createAnomalies |
GET |
/anomalies/{id} |
getAnomalies |
POST |
/scores/{id}/activate |
activateMarketQualityScore |
GET |
/alerts |
listAlertsV2 |
GET |
/market-map |
getUnifiedLiquidityMap |
List market quality scores#
GET /scores
Operation ID: listScores
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with scores:read (serviceCredential)
Service scope: scores:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | MarketQualityScore | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create market quality scores#
POST /scores
Operation ID: createScores
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Append-only aggregate created | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | MarketQualityScore | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one market quality scores aggregate#
GET /scores/{id}
Operation ID: getScores
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with scores:read (serviceCredential)
Service scope: scores:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | MarketQualityScore | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List execution attributions#
GET /attributions
Operation ID: listAttributions
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with receipts:read (serviceCredential)
Service scope: receipts:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | ExecutionAttribution | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create execution attributions#
POST /attributions
Operation ID: createAttributions
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Append-only aggregate created | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | ExecutionAttribution | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one execution attributions aggregate#
GET /attributions/{id}
Operation ID: getAttributions
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with receipts:read (serviceCredential)
Service scope: receipts:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | ExecutionAttribution | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List anomalies#
GET /anomalies
Operation ID: listAnomalies
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with alerts:read (serviceCredential)
Service scope: alerts:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | Anomaly | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create anomalies#
POST /anomalies
Operation ID: createAnomalies
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Append-only aggregate created | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | Anomaly | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one anomalies aggregate#
GET /anomalies/{id}
Operation ID: getAnomalies
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with alerts:read (serviceCredential)
Service scope: alerts:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | Anomaly | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Issuer-review and activate an available immutable analyst score draft#
POST /scores/{id}/activate
Operation ID: activateMarketQualityScore
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
If-Match |
header | Yes | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
MarketQualityScoreActivationRequest
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Activated score and immutable issuer publication-review event | application/json: object |
409 |
Score is unavailable or is not a current draft | No response body declared |
412 |
Strong precondition failed | No response body declared |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
Additional properties rejected |
data.score |
Yes | All of: RecordEnvelope; object |
— |
data.score.allOf[2].payload |
Yes | MarketQualityScore | — |
data.review |
Yes | OperatingSystemEvent | — |
data.executionAuthorityGranted |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List typed anomaly alerts with immutable evidence#
GET /alerts
Operation ID: listAlertsV2
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with alerts:read (serviceCredential)
Service scope: alerts:read. Session access and workspace roles are evaluated separately.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Cursor-paginated alerts | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | Anomaly | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get the unified read-only/write-authority-aware venue map#
GET /market-map
Operation ID: getUnifiedLiquidityMap
Authentication: __Host-klineo_session cookie (sessionCookie)
Observations are included in totals only while their exact source venue-profile generation remains the current VALIDATED or ACTIVE generation; rotated, paused, or revoked lineage is returned as explicitly degraded and excluded.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Venue map with profile-generation match state, availability, and exclusion warnings | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | UnifiedLiquidityMap | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.