Loans

get
Live Loans
https://api.liquid.com/loan_bids?currency={currency}
Get the live loans created.
Request
Response
Request
Query Parameters
currency
required
string
For example: BTC
Response
200: OK
{
  "models": [
    {
      "id": 3580,
      "bidask_type": "limit",
      "quantity": "0.1",
      "currency": "BTC",
      "side": "bid",
      "filled_quantity": "0.0",
      "status": "live",
      "rate": "0.0002",
      "user_id": 3020
    }
  ],
  "current_page": 1,
  "total_pages": 1
}
get
Loans by Currency
https://api.liquid.com/loans?currency={currency}
Get loans by specifying a currency.
Request
Response
Request
Query Parameters
currency
required
string
For example: JPY
Response
200: OK
{
  "models": [
    {
      "id": 144825,
      "quantity": "495.1048",
      "rate": "0.0005",
      "created_at": 1464168246,
      "lender_id": 312,
      "borrower_id": 5712,
      "status": "open",
      "currency": "JPY",
      "fund_reloaned": true
    }
  ],
  "current_page": 1,
  "total_pages": 1
}
get
Trade's Loan
https://api.liquid.com/trades/{trade_id}/loans
Get a trade's loan data e.g loan interest rate.
Request
Response
Request
Path Parameters
trade_id
required
string
Example trade ID:103520
Response
200: OK
[
  {
    "id": 103520,
    "quantity": "42.302",
    "rate": "0.0002",
    "created_at": 1461998432,
    "lender_id": 100,
    "borrower_id": 3020,
    "status": "open",
    "currency": "USD",
    "fund_reloaned": true
  }
]
post
Create a Loan
https://api.liquid.com/loan_bids
Lend your crypto to other traders by specifying quantity and rate.
Request
Response
Request
Body Parameters
quantity
required
string
{"quantity": "0.2"}
currency
required
string
{"currency": "BTC"}
rate
required
string
{"rate": "0.0001"}
Response
200: OK
A loan has been created.
{
    "id": 3580,
    "bidask_type": "limit",
    "quantity": "0.2",
    "currency": "BTC",
    "side": "bid",
    "filled_quantity": "0.0",
    "status": "live",
    "rate": "0.0001",
    "user_id": 3020
}
put
Close a Live Loan
https://api.liquid.com/loan_bids/{loan_id}/close
Close a live loan by loan ID.
Request
Response
Request
Path Parameters
loan_id
required
string
Example of a loan ID:3580
Response
200: OK
{
    "id": 3580,
    "bidask_type": "limit",
    "quantity": "0.1",
    "currency": "BTC",
    "side": "bid",
    "filled_quantity": "0.0",
    "status": "closed",
    "rate": "0.0002",
    "user_id": 3020
}
put
Stops Re-Loaning
https://api.liquid.com/loans/{loan_id}
Stops a loan from re-loaning by specifying an ID.
Request
Response
Request
Path Parameters
loan_id
required
string
Example of a loan ID:144825
Body Parameters
fund_reloaned
required
string
{"fund_reloaned": "false"}
Response
200: OK
{
    "id": 144825,
    "quantity": "495.1048",
    "rate": "0.0005",
    "created_at": 1464168246,
    "lender_id": 312,
    "borrower_id": 5712,
    "status": "open",
    "currency": "JPY",
    "fund_reloaned": false
}
​