Loan

API Integration for Loan Application with StreamNFT

1. Create a Bid Pool

This operation creates a bid pool for a specific collection.

Inialize bid pool

POST/createLoanPool

Body

application/json

interestratestring

graceperiodstring

collectionstring

loandurationstring

secretstring

rawboolean

Response

200500

Successful response

Body

application/json; charset=utf-8

msgstring

Request

JavaScriptCurl

const response = await fetch('/createLoanPool', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "msg": "successful"
}

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/initPool", "POST", new
{
  interestrate = "1",
  graceperiod = "10",
  collection = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  loanduration = "10",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56", //Optional (providing secret send on-chain transaction)
  raw = false //Optional (return raw transaction)
}));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/initPool");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var body= {
  interestrate = "1",
  graceperiod = "10",
  collection = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  loanduration = "10",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56", //Optional (providing secret send on-chain transaction)
  raw = false
}
request.AddBody(body);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

2. Get Bid Pool

This operation retrieves the bid pool.

Get all bid pool

GET/getLoanPool

Response

200500

Successful response

Body

application/json; charset=utf-8

statusboolean

dataarray of LoanPool (object)

Request

JavaScriptCurl

const response = await fetch('/getLoanPool', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "status": false,
    "data": [
      {
        "publicKey": "text",
        "account": {
          "initializerKey": "text",
          "collectionAddress": "text",
          "loanDurationInMinutes": "text",
          "gracePeriodInMinutes": "text",
          "apy": 0,
          "interestRateLender": 0,
          "interestRateProtocol": 0,
          "totalBidManager": "text",
          "lastBidLamports": "text"
        }
      }
    ]
  }
]

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/getBidPool", "GET", null));// Some code

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/getBidPool");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

3. Add Liquidity

This operation adds liquidity to a created Bid Pool.

Initialize a bid manager

POST/addLoanOffer

Body

application/json

biddingoolstring

bidamountstring

totalbidsstring

secretstring

rawboolean

Response

200500

Successful response

Body

application/json; charset=utf-8

msgstring

Request

JavaScriptCurl

const response = await fetch('/addLoanOffer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "msg": "successful"
}

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/initManager", "POST", new
{
  biddingool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  bidamount = "100", // amount in lamports,
  totalbids = "10", // total bids
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56", //Optional (providing secret send on-chain transaction)
  raw = false //Optional (return raw transaction)
}));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/initManager");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var body= {
  biddingool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  bidamount = "100", 
  totalbids = "10", 
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56",
  raw = false 
}
request.AddBody(body);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

4. Get Bid Manager

This operation retrieves the bid manager.

get All bid managers

GET/getLoanOffers

Response

200500

Successful response

Body

application/json; charset=utf-8

statusboolean

dataarray of object

Request

JavaScriptCurl

const response = await fetch('/getLoanOffers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "status": false,
    "data": [
      {
        "publicKey": "text",
        "account": {
          "bidderPubkey": "text",
          "biddingAmountInLamports": "text",
          "biddingNftFloorPrice": 0,
          "biddingPoolAddress": "text",
          "borrowersNftTokenAccountAddress": "text",
          "borrowersAddress": "text",
          "biddingManagerBump": 0,
          "totalBids": "text",
          "pendingLoans": "text"
        }
      }
    ]
  }
]

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/getBidManager", "GET", null));// Some code

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/getBidPool");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

5. Get User Assets

This operation retrieves the assets of a specific user.

Unity

string userAddress = "userAddressHere"; // Replace with the actual user address
StartCoroutine(SendRequest($"http://api.streamnft.tech/getUserAssets/{userAddress}", "GET", null));

C#

using RestSharp;

var userAddress = "2FPSmq9njjsyr4Axb1LDzdooUaVJThXdgHE4Z6Gpaa3h";
var options = new RestClientOptions($"http://api.streamnft.tech/getUserAssets/{userAddress});
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

6. Get Asset Manager

This operation retrieves the asset manager.

Retrieves the assets owned by a specific user.

GET/getAssetInfo/{mint}

Path parameters

mintstring

Response

200500

Successful response

Body

application/json; charset=utf-8

publicKeystring

accountUserAccount (object)

Request

JavaScriptCurl

const response = await fetch('/getAssetInfo/{mint}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "publicKey": "text",
    "account": {
      "initializerKey": "text",
      "initializerTokenAccount": "text",
      "mint": "text",
      "holder": "text",
      "collection": "text",
      "rate": "text",
      "offerExpiry": "text",
      "rentExpiry": "text",
      "state": {},
      "minDuration": "text",
      "fixedDuration": "text",
      "ownerRevenue": "text",
      "holderTokenAccount": "text",
      "whitelist": "text",
      "loanExpiry": "text",
      "bidManagerKey": "text",
      "rentIsFixed": false,
      "lockedInVault": false,
      "vaultAccount": "text"
    }
  }
]

Unity

string mint = "NFTmint"; // Replace with the NFT mint
StartCoroutine(SendRequest($"http://api.streamnft.tech/getAssetInfo/{mint}", "GET", null));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/getAssetManager");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

7. Take Loan

Collection holders can claim loan on their NFTs.

Loan on list bid manager

POST/processLoan

Body

application/json

biddingpoolstring

biddingmanagerstring

nftmintstring

secretstring

rawboolean

Response

200500

Successful response

Body

application/json; charset=utf-8

msgstring

Request

JavaScriptCurl

const response = await fetch('/processLoan', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "msg": "successful"
}

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/processLoan", "POST", new
{
  biddingpool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56",
  raw = false 
}));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/processLoan");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var body= {
  biddingpool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56",
  raw = false
}
request.AddBody(body);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

8. Repay Loan

Repay loan already taken by the user.

Repay an Loan

POST/repayLoan

Body

application/json

biddingpoolaccountstring

biddingmanagerstring

nftmintstring

secretstring

rawboolean

Response

200500

Successful response

Body

application/json; charset=utf-8

msgstring

Request

JavaScriptCurl

const response = await fetch('/repayLoan', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "msg": "successful"
}

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/repayLoan", "POST", new
{
  biddingpoolaccount = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  nftmint = "3YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa33",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56", //Optional (providing secret send on-chain transaction)
  raw = false //Optional (return raw transaction)
}));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/repayLoan");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var body= {
  biddingpoolaccount = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  nftmint = "3YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa33",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56",
  raw = false 
}
request.AddBody(body);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

9. Remove Liquidity

Liquidity providers can remove provided liquidity.

Cancel a bidding manager

POST/removeLoanOffer

Body

application/json

biddingpoolstring

biddingmanagerstring

secretstring

rawboolean

Response

200500

Successful response

Body

application/json; charset=utf-8

msgstring

Request

JavaScriptCurl

const response = await fetch('/removeLoanOffer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "msg": "successful"
}

Unity

StartCoroutine(SendRequest("http://api.streamnft.tech/cancelmanager", "POST", new
{
  biddingpool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
    secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56", //Optional (providing secret send on-chain transaction)
  raw = false //Optional (return raw transaction)
}));

C#

using RestSharp;

var options = new RestClientOptions("http://api.streamnft.tech/cancelmanager");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
var body= {
  biddingpool = "1YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  biddingmanager = "2YeSmq9njjsyr4AYb1LDzdooUaVJThXdgH34Z6Gpaa3h",
  secret = "4uzLYRhX2dnsgUZVNNY82TNFCZbDFt5D9KLJuTFM8X2mc83ACEybEAi8aurEEZJTkSBwp8xg65KKP2ot1cj5Cz56",
  raw = false
}
request.AddBody(body);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);