Omura API (0.0.1)

Download OpenAPI specification:Download

NFT Exchange on Cardano

Pools

Pool Operations

Get a list of pools available on Omura

query Parameters

page	integer Requests a specific page, if not defined, the first page will be returned by default
limit	integer the number of results to be returned per page
sort	string Example: sort=day_volume,asc Sort by a specific column in ascending or descending order
category	string Filters returned results by category
search	string Searches for a specific word or phrase

Responses

Response samples

200
500

Content type

application/json

[{"id": "string",
"img": "string",
"category": "string",
"project_name": "string",
"seven_day_price_change": 0,
"created_at": 0,
"lp_fee": 0,
"seven_day_volume_change": 0,
"symbol": "string",
"token_liquidity": 0,
"verified": true,
"project_name_lower": "string",
"market_cap": 0,
"day_volume": 0,
"day_price_change": 0,
"total_lps": 0,
"seven_day_volume": 0,
"ada_liquidity": 0,
"trading_fees_apr": 0,
"day_volume_change": 0,
"price": 0,
"market_cap_usd": 0
}
]

Get a list of popular pools on Omura

Responses

Response samples

200
500

Content type

application/json

[{"id": "string",
"img": "string",
"category": "string",
"project_name": "string",
"seven_day_price_change": 0,
"created_at": 0,
"lp_fee": 0,
"seven_day_volume_change": 0,
"symbol": "string",
"token_liquidity": 0,
"verified": true,
"project_name_lower": "string",
"market_cap": 0,
"day_volume": 0,
"day_price_change": 0,
"total_lps": 0,
"seven_day_volume": 0,
"ada_liquidity": 0,
"trading_fees_apr": 0,
"day_volume_change": 0,
"price": 0,
"market_cap_usd": 0
}
]

Get the details of a specific pool

path Parameters

poolid

required

string

The pool id to find

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string",
"img": "string",
"category": "string",
"project_name": "string",
"seven_day_price_change": 0,
"created_at": 0,
"lp_fee": 0,
"seven_day_volume_change": 0,
"symbol": "string",
"token_liquidity": 0,
"verified": true,
"project_name_lower": "string",
"market_cap": 0,
"day_volume": 0,
"day_price_change": 0,
"total_lps": 0,
"seven_day_volume": 0,
"ada_liquidity": 0,
"trading_fees_apr": 0,
"day_volume_change": 0,
"price": 0,
"market_cap_usd": 0
}

Users

User Operations

Get the details of a user from a pkh (creates a user if they do not exist)

path Parameters

pkh

required

string

The user public key hash to find

Responses

Response samples

200
500

Content type

application/json

{"user_id": "string"
}

Get the liquidity position of a user

path Parameters

pkh

required

string

The user public key hash to retrieve liquidity for

Responses

Response samples

200
500

Content type

application/json

{"liquidity": [{"id": "string",
"name": "string",
"symbol": "string",
"img": "string",
"pooled_ada": 0,
"pooled_tokens": 0,
"share": 0,
"lp_balance": 0,
"price": 0,
"price_usd": 0
}
],
"value": 0
}

Get the token positions of a user

path Parameters

pkh

required

string

The user public key hash

Responses

Response samples

200
500

Content type

application/json

{"tokens": [{"id": "string",
"name": "string",
"symbol": "string",
"img": "string",
"fpt_balance": 0,
"price": 0,
"price_usd": 0,
"day_price_change": 0,
"day_volume": 0,
"day_volume_change": 0,
"seven_day_volume": 0,
"seven_day_volume_change": 0
}
],
"value": 0
}

Get the token positions of a user

path Parameters

pkh required	string The user public key hash
symbol required	string The symbol of the pool

Responses

Response samples

200
500

Content type

application/json

{"tokens": 0,
"value": 0
}

Get a user's transactions

path Parameters

pkh

required

string

The pkh of the user

query Parameters

page	integer Page to return for pagination
limit	integer the number of results to be returned per page
search	string Symbol to search for
filter	string Enum: "buy" "sell" "liquidity_deposit" "liquidity_withdraw" "fpt_deposit" "fpt_withdraw" Filter to apply

Responses

Response samples

200

Content type

application/json

{"transactions": [{"id": "string",
"pkh": "string",
"status": "string",
"symbol": "string",
"event": "string",
"price": 0,
"img": "string",
"input": [{"amount": 0,
"currency": "string"
}
],
"output": [{"amount": 0,
"currency": "string"
}
],
"timestamp": 0
}
]
}

Update a user

Request Body schema: application/json
required

pkh required	string The user's pkh
username	string The user's new username
email	string <email> The user's new email
image	any The user's new image

Responses

Request samples

Payload

Content type

application/json

{"pkh": "string",
"username": "string",
"email": "user@example.com",
"image": null
}

Response samples

200
400
500

Content type

application/json

{"user": {"id": "string",
"pkh": "string",
"username": "string",
"email": "string",
"image": "string",
"xp": 0
}
}

Create a user

Request Body schema: application/json
required

pkh required	string The user's pkh
username	string The username to use when creating the user
email	string <email> The email to use when creating the user

Responses

Request samples

Payload

Content type

application/json

{"pkh": "string",
"username": "string",
"email": "user@example.com"
}

Response samples

201
400
500

Content type

application/json

{"user": {"id": "string",
"pkh": "string",
"username": "string",
"email": "string",
"image": "string",
"xp": 0
}
}

Get the notifications of a user

path Parameters

pkh

required

string

The pkh to get notifications for

query Parameters

page	number Page number
limit	number Number of items per page

Responses

Response samples

200
500

Content type

application/json

{"notifications": [{"id": "string",
"pkh": "string",
"type": "string",
"timestamp": 0,
"amount": 0,
"feature_name": "string",
"message": "string",
"project_name": "string",
"symbol": "string"
}
],
"amount": 0
}

Exchange

Exchange Operations

get the Omura exchange configuration

Responses

Response samples

200
500

Content type

application/json

{"supported_resolutions": "string",
"exchanges": [{"value": "string",
"name": "string",
"desc": "string"
}
],
"symbols_types": [{"name": "string",
"value": "string"
}
]
}

get symbols on the Omura exchange

query Parameters

pkh required	string The user's pkh
page	number the page to Get
limit	integer the number of results to be returned per page
search	string item to search for

Responses

Response samples

200
500

Content type

application/json

[{"id": "string",
"project_name": "string",
"img": "string",
"symbol": "string",
"category": "string",
"price": 0,
"day_price_change": 0,
"day_price_change_amount": 0,
"day_volume": 0,
"token_liquidity": 0,
"price_usd": 0
}
]

Get bar data for a symbol on the Omura exchange

path Parameters

symbol

required

string

The symbol to get data for

query Parameters

from required	integer The starting timestamp to retrieve data from
to required	integer The ending timestamp to retrieve data to
countBack required	integer The number of bars to retrieve
resolution required	string The resolution of the bars to retrieve. Valid values are 60, 1D or 1W.

Responses

Response samples

200
500

Content type

application/json

[{"open": 0,
"high": 0,
"low": 0,
"close": 0,
"time": 0
}
]

Get transactions for a specific pool

path Parameters

symbol

required

string

The symbol to retrieve transactions for

query Parameters

page	integer page number for pagination
limit	integer the number of results to be returned per page

Responses

Response samples

200
500

Content type

application/json

{"transactions": [{"id": "string",
"pkh": "string",
"status": "string",
"symbol": "string",
"event": "string",
"price": 0,
"img": "string",
"input": [{"amount": 0,
"currency": "string"
}
],
"output": [{"amount": 0,
"currency": "string"
}
],
"timestamp": 0
}
]
}

Get the contract for a liquidity pool

query Parameters

symbol

required

string

the symbol of the pool

Responses

Response samples

200
500

Content type

application/json

{"contract": {"type": "string",
"script": "string"
}
}

Get the available tokens to deposit

query Parameters

symbol required	string The symbol of the pool to deposit into.
pkh required	string The user's public key hash

Responses

Response samples

200

Content type

application/json

{"available": 0,
"assets": {"<token_name>": {"image": "string",
"quantity": 0
}
}
}

Create a transaction to buy tokens from a liquidity pool

Request Body schema: application/json
required

symbol required	string The pool symbol
slippage required	number The requested slippage limit as a number eg 1 = 1%
pkh required	string The user's pkh
user_addr required	string The user's address
ada	number The amount of ada used to buy tokens
tokens	number The amount of tokens to buy. Superceded by the "ada" parameter

Responses

Request samples

Payload

Content type

application/json

{"symbol": "string",
"slippage": 0,
"pkh": "string",
"user_addr": "string",
"ada": 0,
"tokens": 0
}

Response samples

200
400
404
500

Content type

application/json

{"tx": "string"
}

Create a transaction to Sell tokens to a liquidity pool

Request Body schema: application/json
required

symbol required	string The pool symbol
slippage required	number The requested slippage limit as a number eg 1 = 1%
pkh required	string The user's pkh
user_addr required	string The user's address
token_amount required	number The amount of tokens to sell

Responses

Request samples

Payload

Content type

application/json

{"symbol": "string",
"slippage": 0,
"pkh": "string",
"user_addr": "string",
"token_amount": 0
}

Response samples

200
400
404
500

Content type

application/json

{"tx": "string"
}

Create a transaction to claim test NFTs

Request Body schema: application/json
required

pkh required	string The user's pkh
user_addr required	string The user's address

Responses

Request samples

Payload

Content type

application/json

{"pkh": "string",
"user_addr": "string"
}

Response samples

200
400
500

Content type

application/json

{"tx": "string",
"witnesses": ["string"
]
}

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
ada required	number The amount of ada being deposited
token_amount required	number The amount of tokens to be deposited
pkh required	string The user's public key hash

Responses

Request samples

Payload

Content type

application/json

{"symbol": "string",
"ada": 0,
"token_amount": 0,
"pkh": "string"
}

Response samples

200
404
500

Content type

application/json

{"tx": "string"
}

Create a transaction to withdraw tokens from a liquidity pool

Request Body schema: application/json
required

symbol required	string The pool symbol
lp_amount required	number The amount of lp tokens to be exchanged
pkh required	string The user's pkh

Responses

Request samples

Payload

Content type

application/json

{"symbol": "string",
"lp_amount": 0,
"pkh": "string"
}

Response samples

200
404
500

Content type

application/json

{"tx": "string"
}

Tx

Transaction operations

Build a transaction for depositing tokens to receive FPT

Request Body schema: application/json
required

token_policy required	string The policy of the token being locked
symbol required	string The symbol of the project
required	Array of objects The assets being locked

Responses

Request samples

Payload

Content type

application/json

{"token_policy": "string",
"symbol": "string",
"lock_assets": [{"<asset>": 0
}
]
}

Response samples

200
500

Content type

application/json

{"tx": "string"
}

Build a transaction for withdrawing tokens using FPT

Request Body schema: application/json

token_policy required	string The policy of the tokens being unlocked
symbol required	string The symbol of the project
required	Array of objects The assets being unlocked

Responses

Request samples

Payload

Content type

application/json

{"token_policy": "string",
"symbol": "string",
"unlock_assets": [{"<asset>": 0
}
]
}

Response samples

200
500

Content type

application/json

{"tx": "string"
}

Preview a buy transaction

path Parameters

symbol

required

string

The symbol of the pool

query Parameters

ada	integer The number of ada used to buy tokens
tokens	integer The number of tokens to buy
slippage required	integer The requested slippage limit as a number eg 1 = 1%

Responses

Response samples

200
500

Content type

application/json

{"minimum_receive": "string",
"cost": "string",
"price_impact": 0,
"lp_fee": 0,
"batcher_fee": 0,
"deposit_ada": 0
}

Preview a sell transaction

path Parameters

symbol

required

string

The symbol of the pool

query Parameters

tokens required	integer The number of tokens to sell
slippage required	integer The requested slippage limit as a number eg 1 = 1%

Responses

Response samples

200
500

Content type

application/json

{"minimum_receive": "string",
"price_impact": 0,
"lp_fee": 0,
"batcher_fee": 0,
"deposit_ada": 0
}

Submit a transaction to the blockchain

Request Body schema: application/json
required

type required	string The type of transaction
tx required	string The transaction body
witness required	string The transaction witness
pkh required	string The user's pkh

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"tx": "string",
"witness": "string",
"pkh": "string"
}

Response samples

200
500

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

Responses

Response samples

200

Content type

application/json

{"share": 0,
"required_ada": 0,
"price": 0
}

/previewLiquidityWithdraw

path Parameters

symbol

required

string

The symbol to retrieve transactions for

query Parameters

amount	integer the number of LPs to cash in
pkh required	string The user's pub key hash

Responses

Response samples

200

Content type

application/json

{"pooled_ada": 0,
"pooled_tokens": 0,
"share": 0,
"ada_received": 0,
"tokens_received": 0,
"price": 0
}

Omura API (0.0.1)

Pools

Get a list of pools available on Omura

query Parameters

Responses

Response samples

Get a list of popular pools on Omura

Responses

Response samples

Get the details of a specific pool

path Parameters

Responses

Response samples

Users

Get the details of a user from a pkh (creates a user if they do not exist)

path Parameters

Responses

Response samples

Get the liquidity position of a user

path Parameters

Responses

Response samples

Get the token positions of a user

path Parameters

Responses

Response samples

Get the token positions of a user

path Parameters

Responses

Response samples

Get a user's transactions

path Parameters

query Parameters

Responses

Response samples

Update a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the notifications of a user

path Parameters

query Parameters

Responses

Response samples

Exchange

get the Omura exchange configuration

Responses

Response samples

get symbols on the Omura exchange

query Parameters

Responses

Response samples

Get bar data for a symbol on the Omura exchange

path Parameters

query Parameters

Responses

Response samples

Get transactions for a specific pool

path Parameters

query Parameters

Responses

Response samples

Get the contract for a liquidity pool

query Parameters

Responses

Response samples

Get the available tokens to deposit

query Parameters

Responses

Response samples

Create a transaction to buy tokens from a liquidity pool

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required