From 9c92f7d636b4a25bb3ce74e531894289df921d09 Mon Sep 17 00:00:00 2001 From: Tenancio Date: Mon, 11 Mar 2024 12:13:37 +0000 Subject: [PATCH] update docs --- index.html | 10 +++++----- openapi.yaml | 19 +++++++++++++++---- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index 7b8fa49..7abc5b0 100644 --- a/index.html +++ b/index.html @@ -337,7 +337,7 @@ -
API docs by Redocly
API docs by Redocly

The user's public key hash

Responses

Response samples

Content type
application/json
{
  • "assets": {
    }
}

Liquidity

Response samples

Content type
application/json
{
  • "available": 0,
  • "assets": {
    }
}

Liquidity

Liquidity Operations

Create a transaction to deposit tokens to a liquidity pool

Request Body schema: application/json
required
symbol
required
string

The pool symbol

@@ -541,7 +541,7 @@ " class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk">

An Unsigned Transaction

Request samples

Content type
application/json
{
  • "token_policy": "string",
  • "symbol": "string",
  • "unlock_assets": [
    ]
}

Response samples

Content type
application/json
{
  • "tx": "string"
}

Sumbit a transaction to the blockchain

Request Body schema: application/json
required
type
required
string

Request samples

Content type
application/json
{
  • "token_policy": "string",
  • "symbol": "string",
  • "unlock_assets": [
    ]
}

Response samples

Content type
application/json
{
  • "tx": "string"
}

Sumbit a transaction to the blockchain

Request Body schema: application/json
required
type
required
string

The type of transaction

tx
required
string

The transaction body

@@ -553,7 +553,7 @@ " class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk">

A Tx Hash

Request samples

Content type
application/json
{
  • "type": "string",
  • "tx": "string",
  • "witness": "string",
  • "pkh": "string"
}

Response samples

Content type
application/json
{
  • "txHash": "string"
}

/previewLiquidityDeposit

path Parameters
symbol
required
string

Request samples

Content type
application/json
{
  • "type": "string",
  • "tx": "string",
  • "witness": "string",
  • "pkh": "string"
}

Response samples

Content type
application/json
{
  • "txHash": "string"
}

/previewLiquidityDeposit

path Parameters
symbol
required
string

The symbol to retrieve transactions for

query Parameters
token_amount
integer

the number of tokens to deposit

@@ -569,7 +569,7 @@ " class="sc-iKOmoZ sc-cCzLxZ WVNwY VEBGS sc-ckdEwu LxEPk">

Preview of the user's share and required ada

Response samples

Content type
application/json
{
  • "pooled_ada": 0,
  • "pooled_tokens": 0,
  • "share": 0,
  • "ada_received": 0,
  • "tokens_received": 0,
  • "price": 0
}