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.

get

Returns rentals where the user/account is the borrower

Path parameters

userAddressstringRequired

User Address/Account

chainIdstringRequired

Network Chain Id. See supported networks.

tokenAddressstringRequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstringOptional

Cursor to paginate the query to. It starts at '1 or null' and is offset using the cursor field returned in the query result.

Default: 1

sizeinteger · int64OptionalDefault: 20

Responses

get

HTTPcURLJavaScriptPython

GET /v1/borrowings/{userAddress}/{chainId}/{tokenAddress} HTTP/1.1
Host: api.orium.network
Accept: */*

{
  "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": true,
        "revocable": true,
        "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.

get

Returns rentals where the user/account is the lender

Path parameters

userAddressstringRequired

User Address/Account

chainIdstringRequired

Network Chain Id. See supported networks.

tokenAddressstringRequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstringOptional

Cursor to paginate the query to. It starts at '1 or null' and is offset using the cursor field returned in the query result.

Default: 1

sizeinteger · int64OptionalDefault: 20

Responses

get

HTTPcURLJavaScriptPython

GET /v1/lendings/{userAddress}/{chainId}/{tokenAddress} HTTP/1.1
Host: api.orium.network
Accept: */*

{
  "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": true,
        "revocable": true,
        "customData": "text"
      }
    }
  ],
  "cursor": "text",
  "error": null
}

User Active Rental Offers

Active rental offers represent rental offers a user has created for rent.

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

get

Returns rental offers where the user/account is the owner

Path parameters

userAddressstringRequired

User Address/Account

chainIdstringRequired

Network Chain Id. See supported networks.

tokenAddressstringRequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstringOptional

Cursor to paginate the query to. It starts at '1 or null' and is offset using the cursor field returned in the query result.

Default: 1

sizeinteger · int64OptionalDefault: 20

Responses

get

HTTPcURLJavaScriptPython

GET /v1/rental-offers/{userAddress}/{chainId}/{tokenAddress} HTTP/1.1
Host: api.orium.network
Accept: */*

{
  "result": [
    {
      "offerId": "text",
      "deadline": "text",
      "price": {
        "tokenAddress": "text",
        "amount": "text"
      },
      "nft": {
        "chainId": "text",
        "tokenAmount": "text",
        "tokenAddress": "text",
        "tokenId": "text",
        "metadata": {
          "name": "text",
          "imageUrl": "text",
          "attributes": [
            {
              "trait": "text",
              "value": "text"
            }
          ]
        }
      },
      "roles": [
        {
          "id": "text",
          "name": "text",
          "inputs": [
            {}
          ],
          "description": "text",
          "isUniqueRole": true
        }
      ],
      "createdAt": "text",
      "minDuration": "text"
    }
  ],
  "cursor": "text",
  "error": null
}