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

get

/v1/borrowings/{userAddress}//{chainId}//{tokenAddress}

Path parameters

userAddressstringrequired

User Address/Account

chainIdstringrequired

Network Chain Id. See supported networks.

tokenAddressstringrequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstring · default: 1

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

sizeinteger · int64 · default: 20

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orium.network/v1/borrowings/{userAddress}/{chainId}/{tokenAddress}'

200

400

200

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

Successful operation

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

get

/v1/lendings/{userAddress}//{chainId}//{tokenAddress}

Path parameters

userAddressstringrequired

User Address/Account

chainIdstringrequired

Network Chain Id. See supported networks.

tokenAddressstringrequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstring · default: 1

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

sizeinteger · int64 · default: 20

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orium.network/v1/lendings/{userAddress}/{chainId}/{tokenAddress}'

200

400

200

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

Successful operation

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.

Returns rental offers where the user/account is the owner

get

/v1/rental-offers/{userAddress}//{chainId}//{tokenAddress}

Path parameters

userAddressstringrequired

User Address/Account

chainIdstringrequired

Network Chain Id. See supported networks.

tokenAddressstringrequired

NFT collection Token Address. See supported collections.

Query parameters

cursorstring · default: 1

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

sizeinteger · int64 · default: 20

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.orium.network/v1/rental-offers/{userAddress}/{chainId}/{tokenAddress}'

200

400

200

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

Successful operation