API Specification

This page contains the specification of Orium's API for third-party integration partners.

Supported Blockchains

---

Blockchain Name	Orium Chain ID	EVM Chain Id
Polygon	polygon-mainnet	137 (0x89)
Moonbeam	polkadot-moonbeam	1284 (0x504)
Arbitrum One	arbitrum-one	42161 (0xa4b1)

Endpoints

---

User Borrowings

Borrowings represent rentals a user has rented.

Given a user address and an NFT, list all active borrowing a user has.

Returns rentals where the user/account is the borrower

GEThttps://nest-api.orium.network/v1/borrowings/{userAddress}/{chainId}/{tokenAddress}

Path parameters

userAddress*string

User Address/Account

chainId*string

Network Chain Id. See supported networks.

tokenAddress*string

NFT collection Token Address. See supported collections.

Query parameters

Response

200400

Successful operation

Body

application/json

resultarray of Borrowing (object)

cursornullable string

errorstring

Request

JavaScriptCurlPython

const response = await fetch('https://nest-api.orium.network/v1/borrowings/{userAddress}/{chainId}/{tokenAddress}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "result": [
    {
      "lender": "text",
      "borrower": "text",
      "createdAt": "text",
      "expirationDate": "text",
      "nft": {
        "chainId": "text",
        "tokenId": "text",
        "tokenAddress": "text",
        "tokenAmount": "text"
      },
      "role": {
        "id": "text",
        "name": "text",
        "inputs": [
          {
            "name": "text",
            "type": "text",
            "validation": "text",
            "components": [
              {
                "name": "text",
                "type": "text",
                "validation": "text"
              }
            ]
          }
        ],
        "description": "text",
        "isUniqueRole": false,
        "revocable": false,
        "customData": "text"
      }
    }
  ],
  "cursor": "text",
  "error": null
}

User Lendings

Lendings represent rentals a user has rented to other users (the provided user is the owner of the NFTs).

Given a user address and an NFT, list all active lendings a user has.

Returns rentals where the user/account is the lender

GEThttps://nest-api.orium.network/v1/lendings/{userAddress}/{chainId}/{tokenAddress}

Path parameters

userAddress*string

User Address/Account

chainId*string

Network Chain Id. See supported networks.

tokenAddress*string

NFT collection Token Address. See supported collections.

Query parameters

Response

200400

Successful operation

Body

application/json

resultarray of Borrowing (object)

cursornullable string

errorstring

Request

JavaScriptCurlPython

const response = await fetch('https://nest-api.orium.network/v1/lendings/{userAddress}/{chainId}/{tokenAddress}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "result": [
    {
      "lender": "text",
      "borrower": "text",
      "createdAt": "text",
      "expirationDate": "text",
      "nft": {
        "chainId": "text",
        "tokenId": "text",
        "tokenAddress": "text",
        "tokenAmount": "text"
      },
      "role": {
        "id": "text",
        "name": "text",
        "inputs": [
          {
            "name": "text",
            "type": "text",
            "validation": "text",
            "components": [
              {
                "name": "text",
                "type": "text",
                "validation": "text"
              }
            ]
          }
        ],
        "description": "text",
        "isUniqueRole": false,
        "revocable": false,
        "customData": "text"
      }
    }
  ],
  "cursor": "text",
  "error": null
}