Klineo/Docs
Open app ↗

API v1 reference

v1 · Venues, allocations and migrations

Paths on this page are relative to /api/liquidity-studio/v1. Authentication and required headers vary by operation.

API reference overview · OpenAPI download

Operations on this page#

Method Path Operation
GET /venues/bdex/deployments/current getVenuesBdexDeploymentsCurrent
GET /venues/bdex/deployments/{factoryAddress}/assessments getVenuesBdexDeploymentsByFactoryAddressAssessments
POST /venues/bdex/deployments/assessments postVenuesBdexDeploymentsAssessments

getVenuesBdexDeploymentsCurrent#

GET /venues/bdex/deployments/current

Operation ID: getVenuesBdexDeploymentsCurrent

Authentication: __Host-klineo_session cookie (sessionCookie)

This operation declares no parameters.

Responses#

Status Description Content type and schema
200 Successful response application/json: object
default Structured API error application/json: ApiErrorEnvelope

200 application/json body

object

Field Required at this level Type Description and constraints
data Yes object The typed runtime domain record returned by this operation. Additional properties allowed

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

getVenuesBdexDeploymentsByFactoryAddressAssessments#

GET /venues/bdex/deployments/{factoryAddress}/assessments

Operation ID: getVenuesBdexDeploymentsByFactoryAddressAssessments

Authentication: __Host-klineo_session cookie (sessionCookie)

Parameters#

Name Location Required Type Description and constraints
factoryAddress path Yes string Min length: 1

Responses#

Status Description Content type and schema
200 Successful response application/json: object
default Structured API error application/json: ApiErrorEnvelope

200 application/json body

object

Field Required at this level Type Description and constraints
data Yes object The typed runtime domain record returned by this operation. Additional properties allowed

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

postVenuesBdexDeploymentsAssessments#

POST /venues/bdex/deployments/assessments

Operation ID: postVenuesBdexDeploymentsAssessments

Authentication: __Host-klineo_session cookie (sessionCookie)

Parameters#

Name Location Required Type Description and constraints
Idempotency-Key header Yes string Min length: 8; Max length: 163

Request body#

Required: yes.

application/json

object — Additional properties rejected

Field Required at this level Type Description and constraints
factoryAddress Yes string Pattern: ^0x[0-9a-fA-F]{40}$
reason Yes string Min length: 12; Max length: 500

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Responses#

Status Description Content type and schema
201 Successful response application/json: object
default Structured API error application/json: ApiErrorEnvelope

201 application/json body

object

Field Required at this level Type Description and constraints
data Yes object The typed runtime domain record returned by this operation. Additional properties allowed

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.