Reddio NFT, Token and IPFS
Reddio APIs provide the layer 2 zkRollup APIs powered by StarkEx from StarkWare, enabling 0 gas fee on layer 2 and 10k TPS. This new zkRollup technology is being widely use by many NFT marketplaces, GameFi , Defi projects etc.
Reddio NFT, Token and IPFS endpoints
| Method | Endpoint | Description |
|---|---|---|
| Assets | ||
| GET |
GetAssetsdetailbyassetid /v1/assetid/{asset_id} |
The API can query every asset_id that exists on reddio's system, if the FT/NFT is not on reddio's system, then the API will not work well The API returns assets detail including… |
| GET |
GetAssetsbycontractinformation /v1/assetid |
This request will return asset_id wrapped with return code and error code |
| Balances | ||
| GET |
Balanceofstark_keyandasset_id /v1/balance |
This API retrieves the balance of a stark_key and asset_id The return values description | **key** | **description** | | --- | --- | | asset_id | The asset's id | |… |
| GET |
Balancesofstark_key /v1/balances |
The API retrieves the balance of a stark_key, each return value are as the previous field |
| GET |
Aggregationbalanceofastark_keybycontractaddress /v2/balances |
The API aggregation balances by contract address, for previous API, each NFT have an asset_id, but in this API. NFT do not have asset_id when return, but has token id |
| Mints NFT | ||
| POST |
Mintsometokens /v1/mints |
Body parameters | **item** | **description** | | --- | --- | | contract_address | the contract address you registered and want to mint | | stark_key | the stark_key you want to… |
| Records | ||
| GET |
GetRecordsbystark_key /v1/records |
|
| GET |
Getrecordbysequenceid /v1/record |
|
| GET |
Getrecordbysignature /v1/record/by/signature |
|
| Collections | ||
| GET |
Listcolloction'snftowners /v1/nfts/{contract_address} |
The api returns a collection's nft owners. The response field description | **field** | **description** | | --- | --- | | contract_address | the contract_address of the… |
| GET |
Listallcollections /v1/collections |
The API lists all collections on Reddio's layer2 system. The return field is like the following descrption | **field** | **description** | | --- | --- | | contract_address | The… |
| Transfer NFT/ERC20/ETH | ||
| POST |
TransferNFT /v1/transfers |
Body parameters Transfer transfers tokens(asset_id) from stark_key to receiver | **field** | **description** | | --- | --- | | amount | the amount to be transferred. | | nonce |… |
| Withdrawal NFT/ERC20/ETH | ||
| POST |
WithdrawalaNFT /v1/withdrawalto |
Withdrawal withdraw tokens(asset_id) from stark_key to receiver | **field** | **description** | | --- | --- | | amount | the amount to be transferred. | | nonce | the nonce of… |
| Orders | ||
| GET |
GetOrderInfo /v1/order/info |
This API is to get order related information, such as the asset id of base/quota tokens. nonce and vaults related to stark_key **If you use SDKs(including java/unity/js), you do… |
| GET |
ListOrders /v1/orders |
|
| GET |
GetOrderbyOrderID /v1/order |
The API will return the order related to the order id There are many informations it returns | **field** | **description** | | --- | --- | | order_id | the id of the order, it is… |
| POST |
SellanNFT /v1/order |
Sell an NFT sells an NFT Body parameters | **field** | **description** | | --- | --- | | amount | the amount to sell | | price | the price of the NFT | | stark_key | the… |
| Storage(IPFS) | ||
| GET |
Listfilesunderproject /v1/project/{project_uuid}/storage |
It will list files under the project, the response item like | **field** | **description** | | --- | --- | | cid | [Content… |
| POST |
UploadFiles /v1/project/{project_uuid}/storage |
Upload files will return [cid](https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid) and endpoints |
| Vaults | ||
| GET |
Getvaultsbystark_keyandasset_id /v1/vaults |
|
| GET |
Getvaultsdetailbyvaultid /v1/vaults/{vault_id} |
|
| Nonce | ||
| GET |
Getnoncebystark_key /v1/nonce |
|
| Wallets | ||
| GET |
Getwallets /v1/wallets |
The return field as following | **field** | **description** | | --- | --- | | stark_key | the stark public key | | stark_private_key | the stark private key | |
| Marketplace | ||
| GET |
GetMarketplaces /v1/project/{project_uuid}/marketplace |
|
| POST |
RemoveMarketplace /v1/marketplace/remove_marketplace |
|
| POST |
CreateMarketplace /v1/marketplace |
|
Reddio NFT, Token and IPFS pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|