API Reference

Nomial V1 API Reference

Note: for API access, please connect with the Nomial team. See the Connect with us page.

Data Types

Name	Description
address	String in the form of "0x..."
uint	Unsigned int

State Data

The following API methods are convenience functions to generate transactions for submission to the blockchain. Some require prior calls to request signatures from Validators.

Get Pools

GET /pools

Get state data for collateral and inventory pools.

Headers

Name	Value
Content-Type	application/json

Body

No parameters

Get Borrower State

GET /borrowers/{borrowerAddress}/status

Get state data for borrower (e.g., a solver).

URL Parameters

Name	Type
borrowerAddress	address

Headers

Name	Value
Content-Type	application/json

Body

No parameters

Generate Transactions

The following API methods are convenience functions to generate transactions for submission to the blockchain. Some require prior calls to request signatures from Validators.

Collateral Deposit

GET /collateralDeposit

Generate a fully formed transaction to deposit collateral in a collateral pool.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint

Start Withdraw

GET /startWithdraw

Generate a fully formed transaction to withdraw collateral from a collateral pool.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint

Withdraw

GET /withdraw

Generate a fully formed transaction to withdraw collateral from a collateral pool seven days after startWithdraw.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint

Borrow

GET /borrow

Generate a fully formed transaction to borrow from an inventory pool. Requires signature from validators.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint
recipient	address
validatorSignature

Repay

GET /borrow

Generate a fully formed transaction to repay an inventory pool.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint

Request Permission Signatures from Validators

Borrow Request

POST /borrowRequest

Request a signed borrow permission from validators.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type
solver	address
token	address
amount	uint