NFT API

API Reference

Get Collections

GET https://open-api.openocean.finance/nft/v2/:chain/collections

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

offset

String

pagination(response next)

limit

String

pagination limit(max 20)

sort

String

descending (allTimeVolume,1DayVolume,7DayVolume,30DayVolume)

filters

String

address(specify collection details) or text(fuzzy match collection name)

fuzzy match collection name response：

{
    "code":0,
    "data":[
        {
            "id":"0xaadba140ae5e4c8a9ef0cc86ea3124b446e3e46a",
            "slug":"mutantcats",
            "name":"MutantCats",
            "image":"https://i.seadn.io/gcs/files/785aa6b9f07435e690956aa27ada6eee.png?w=500&auto=format",
            "primaryContract":"0xaadba140ae5e4c8a9ef0cc86ea3124b446e3e46a",
            "discordUrl":"https://discord.gg/mutantcats",
            "twitterUsername":"mutantcatsDAO",
            "description":"9,999 cats mutated by a disease on the Ethereum blockchain. Each Mutant Cat NFT grants access to the exclusive DAO community and voting rights over the DAO's assets.",
            "tokenCount":"9999",
            "onSaleCount":"120",
            "floorAskPrice":0.145,
            "floorPrice":{
                "symbol":"ETH",
                "icon":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png",
                "value":0.145
            },
            "offerMinPrice":0.0145,
            "isCollectionOffersEnabled":true,
            "volume":{
                "1day":1.677,
                "7day":10.29991,
                "30day":45.00287,
                "allTime":16854.96768
            },
            "volumeChange":{
                "1day":11.893617021276595,
                "7day":0.6539036675936096,
                "30day":1.757470164370173
            },
            "isVerified":true
        }
    ]
}

specify collection details response：

{
    "code":0,
    "data":{
        "id":"0x354634c4621cdfb7a25e6486cca1e019777d841b",
        "slug":"mutant-hounds",
        "name":"Mutant Hounds",
        "image":"https://i.seadn.io/gcs/files/03a077ba38525dffdefae8add307da05.png?w=500&auto=format",
        "primaryContract":"0x354634c4621cdfb7a25e6486cca1e019777d841b",
        "discordUrl":null,
        "twitterUsername":"MutantHounds",
        "description":"Mutant Hounds Are Insane. !howl\n\nOur Discord: http://discord.com/invite/mutantcartel",
        "tokenCount":"7579",
        "ownerCount":2626,
        "onSaleCount":"677",
        "floorAskPrice":0.3155,
        "floorPrice":{
            "symbol":"ETH",
            "icon":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png",
            "value":0.3155
        },
        "offerMinPrice":0.03155,
        "isCollectionOffersEnabled":true,
        "volume":{
            "1day":14.9169,
            "7day":158.51282,
            "30day":878.5984,
            "allTime":5112.71505
        },
        "volumeChange":{
            "1day":0.947083114290721,
            "7day":0.780128771183771,
            "30day":0.20750453403519828
        },
        "attributes":[
            {
                "key":"Mega",
                "attributeCount":6,
                "kind":"string",
                "values":[
                    {
                        "count":1,
                        "value":"Ares"
                    },
                    {
                        "count":1,
                        "value":"Caleb Lockjaw"
                    },
                    {
                        "count":1,
                        "value":"Fiend"
                    },
                    {
                        "count":1,
                        "value":"Glitch"
                    },
                    {
                        "count":1,
                        "value":"Primo",
                        "floorAskPrice":150
                    },
                    {
                        "count":1,
                        "value":"Volt"
                    }
                ]
            }
        ],
        "metadata":{
            "imageUrl":"https://i.seadn.io/gcs/files/03a077ba38525dffdefae8add307da05.png?w=500&auto=format",
            "discordUrl":null,
            "description":"Mutant Hounds Are Insane. !howl\n\nOur Discord: http://discord.com/invite/mutantcartel",
            "externalUrl":null,
            "bannerImageUrl":"https://i.seadn.io/gcs/files/34b9b2939f421c213a82cfbbce46fc89.png?w=500&auto=format",
            "twitterUsername":"MutantHounds",
            "safelistRequestStatus":"approved"
        },
        "isVerified":false,
        "marketplaceList":[
            {
                "value":"opensea",
                "label":"OpenSea"
            },
            {
                "value":"x2y2",
                "label":"X2Y2"
            },
            {
                "value":"looksrare",
                "label":"LooksRare"
            },
            {
                "value":"sudoswap",
                "label":"SudoSwap"
            }
        ]
    }
}

Get Asset

GET https://open-api.openocean.finance/nft/v1/:chain/assets

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

limit

number

limit(max 500)

offset

String

pagination(response next)

filters

object

address + tokenId(specify nft details) or address/text(match collection orders)

{
    "code": 0,
    "message": "ok",
    "next": "MTAwMDAwMDAwMDAwMDAwMF8yNTQx",
    "data": [
        {
            "tokenId": "1",
            "tokenAddress": "0x1da1c30436ed44774406daeeef26860791fb48cb",
            "name": "The Other Side",
            "description": "Appearances can be deceiving.\nSometimes it hides something else.",
            "owner": {
                "user": {
                    "username": "19YAKIM87"
                },
                "profile_img_url": "https://storage.googleapis.com/opensea-static/opensea-profile/2.png",
                "address": "0xd71bc875138433e62f2b29117d64dff88f038e68",
                "config": ""
            },
            "assetContract": {
                "name": "Diary of the Future",
                "description": null,
                "type": "non-fungible",
                "schemaName": "ERC721",
                "address": "0x1da1c30436ed44774406daeeef26860791fb48cb",
                "tokenSymbol": "10",
                ...
            },
            "collection": {
                "createdDate": "2022-06-01T09:50:54.797Z",
                "name": "Diary of the Future",
                "description": null,
                "slug": "diary-of-the-future",
                "hidden": false,
                ...
            },
            "orders": null,
            "sellOrders": [{market: '', order: ''}],
            "buyOrders": null,
            ...
            "transferFee": null,
            "transferFeePaymentToken": null
        }
    ]
}

Get Buy Transaction

POST https://open-api.openocean.finance/nft/v1/:chain/buy

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

sender*

String

buyer

balanceTokens*

array[object]

payment token list(ERC20 + ETH)

dustTokens*

array[object]

remaining amount is transferred to the token list

buy*

array[object]

nft order list

{
    "code":0,
    "message":"ok",
    "data":{
        "from":"0x36b35012F3728105ea3f49830ccdFBa615C1d8c9",
        "data":"0x09ba153d000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001400000000000000000000000000000000000000000000000000000000000000660000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000100000000000000000000000049d5c2bdffac6ce2bfdb6640f4f80f226bc10bab000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000071e49281a63e20000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000226abadc42f80000000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000044481ae255a000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000c000000000000000000000000076daaaf7711f0dc2a34bca5e13796b7c5d862b53000000000000000000000000000000000000000000000000000000000000570c00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000226abadc42f8000000000000000000000000000000000000000000000000000000000000000034cfb0f3ee10000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000223ead2047c1000000000000000000000000000e70adc8cb03979307d6f7a7a075f9b577c474b1c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000076daaaf7711f0dc2a34bca5e13796b7c5d862b53000000000000000000000000000000000000000000000000000000000000570c000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000063f7bf87000000000000000000000000000000000000000000000000000000006404ac900000000000000000000000000000000000000000000000000000000000000000360c6ebe00000000000000000000000000000000000000009d3b7705c2e31cbf0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f00000000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f00000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000024000000000000000000000000000000000000000000000000000000000000002a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000002c0dbbfb370000000000000000000000000000000a26b00c1f0df003000390027140000faa719000000000000000000000000000000000000000000000000000000000000004168b879d570171abddcee01ac1961cf6056f81ff42aad2221b35b52320a86172d137cdada3b45339c6b873394bbaaea946e1ce172c3b7ec65818a5c10f818301f1c0000000000000000000000000000000000000000000000000000000000000000000000360c6ebe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000b04593427b6000000000000000000000000000000000000000000000000000000000000010000000000000000000000000049d5c2bdffac6ce2bfdb6640f4f80f226bc10bab00000000000000000000000000000000000000000000000000071e49281a63e20000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000009c490411a3200000000000000000000000007749429d3d9047a966b28a489500325bac9f1b6000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000049d5c2bdffac6ce2bfdb6640f4f80f226bc10bab000000000000000000000000000000000000000000000000000000000000000000000000000000000000000007749429d3d9047a966b28a489500325bac9f1b600000000000000000000000022c389e690b33842bf9430104c59d2b3916c1aa700000000000000000000000000000000000000000000000000071e49281a63e2000000000000000000000000000000000000000000000000027d8c6464debb3c0000000000000000000000000000000000000000000000000283fd008f433e6b00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000002400000000000000000000000000000000000000000000000000000000000000460000000000000000000000000000000000000000000000000000000000000058000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000104aeba9ec10000000000000000000000001701a7e5034ed1e35c52245ab7c07dbdaf353de7000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000071e49281a63e200000000000000000000000007749429d3d9047a966b28a489500325bac9f1b600000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000002b49d5c2bdffac6ce2bfdb6640f4f80f226bc10bab000028b31f66aa3c1e785363f0875a1b74e27b85fd66c700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001649f865422000000000000000000000000b31f66aa3c1e785363f0875a1b74e27b85fd66c7000000000000000000000000000000010000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000004000000000000000000000000b31f66aa3c1e785363f0875a1b74e27b85fd66c700000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000242e1a7d4d00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000648a6a1e850000000000000000000000000000000000000000000000000000000000000000000000000000000000000000353c1f0bc78fbbc245b3c93ef77b1dcc5b77d2a02710000000000000000000000000000000000000000000000283fd008f433e6b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001a49f865422000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000004400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000064d1660f99000000000000000000000000000000000000000000000000000000000000000000000000000000000000000022c389e690b33842bf9430104c59d2b3916c1aa70000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "to":"0x22c389e690b33842bf9430104c59d2B3916C1Aa7",
        "value":"0x",
        "approve":[
            {
                "from":"0x36b35012f3728105ea3f49830ccdfba615c1d8c9",
                "data":"0x095ea7b300000000000000000000000022c389e690b33842bf9430104c59d2b3916c1aa7ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
                "to":"0x49D5c2BdFfac6CE2BFdB6640F4F80f226bc10bAB",
                "value":"0x"
            }
        ]
    }
}

Get Sell Signature Data

POST https://open-api.openocean.finance/nft/v1/:chain/sell

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

market*

String

marketplace opensea/looksrare/x2y2

sell*

array[object]

nft sell list

sender*

String

seller

{
    "code": 0,
    "message": "ok",
    "data": {
        "makerOrder": { // Order data for signature
            "isOrderAsk": true,
            "signer": "0x1cad209a2022747a0c8c538ee7d99fd1060fd175",
            "collection": "0xd4C4643053E46eacffa06E2573641907a54125Fb",
            "price": "100000000000000",
            "tokenId": "318",
            "amount": "1",
            "strategy": "0x732319A3590E4fA838C111826f9584a9A2fDEa1a",
            "currency": "0xc778417E063141139Fce010982780140Aa0cD5Ab",
            "nonce": 0,
            "startTime": 1655363481,
            "endTime": 1655449881,
            "minPercentageToAsk": 8500,
            "params": []
        },
        "orderHash": "0xda105357dab470fb524e4c4c22ad9b00d21b5ae0fc38327bc92268f4c77df4bc" // unique to x2y2
        "approve": { // approve data
            "from": "0x1cad209a2022747a0c8c538ee7d99fd1060fd175",
            "data": "0xa22cb4650000000000000000000000003f65a762f15d01809cdc6b43d8849ff24949c86a0000000000000000000000000000000000000000000000000000000000000001",
            "to": "0xd4C4643053E46eacffa06E2573641907a54125Fb",
            "value": "0x"
        }
    }
}

Get offer signature data

POST https://open-api.openocean.finance/nft/v1/:chain/offer

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

market*

String

marketplace opensea/looksrare/x2y2

sender*

String

buyer

offer*

array[object]

nft offer list

{
    "code": 0,
    "message": "ok",
    "data": {
        "makerOrder": { // Order data for signature
            "isOrderAsk": true,
            "signer": "0x1cad209a2022747a0c8c538ee7d99fd1060fd175",
            "collection": "0xd4C4643053E46eacffa06E2573641907a54125Fb",
            "price": "100000000000000",
            "tokenId": "318",
            "amount": "1",
            "strategy": "0x732319A3590E4fA838C111826f9584a9A2fDEa1a",
            "currency": "0xc778417E063141139Fce010982780140Aa0cD5Ab",
            "nonce": 0,
            "startTime": 1655363481,
            "endTime": 1655449881,
            "minPercentageToAsk": 8500,
            "params": []
        },
        "orderHash": "0xda105357dab470fb524e4c4c22ad9b00d21b5ae0fc38327bc92268f4c77df4bc" // unique to x2y2
        "approve": { // approve data
            "from": "0x1cad209a2022747a0c8c538ee7d99fd1060fd175",
            "data": "0xa22cb4650000000000000000000000003f65a762f15d01809cdc6b43d8849ff24949c86a0000000000000000000000000000000000000000000000000000000000000001",
            "to": "0xd4C4643053E46eacffa06E2573641907a54125Fb",
            "value": "0x"
        }
    }
}

Submit Order

POST https://open-api.openocean.finance/nft/v1/:chain/sign

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

market*

String

marketplace opensea/looksrare/x2y2

order*

String

sell/offer makerOrder

signature*

String

signature result

{
    "code": 0,
    "message": "ok"
}

Get Rankings

GET https://open-api.openocean.finance/nft/v2/:chain/rankings

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

time

String

1d 7d 30d all. 1d for default

offset

number

pagination

limit

number

pagination limit(max 20)

{
    "code":0,
    "message":"ok",
    "data":[
        {
            "id":"0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "slug":"boredapeyachtclub",
            "name":"Bored Ape Yacht Club",
            "image":"https://i.seadn.io/gae/Ju9CkWtV-1Okvf45wo8UctR-M9He2PjILP0oOvxE89AyiPPGtrR3gysu1Zgy0hjd2xKIgjJJtWIc0ybj4Vd7wv8t3pxDGHoJBzDB?w=500&auto=format",
            "primaryContract":"0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
            "discordUrl":"https://discord.gg/3P5K3dzgdB",
            "twitterUsername":"BoredApeYC",
            "description":"The Bored Ape Yacht Club is a collection of 10,000 unique Bored Ape NFTs— unique digital collectibles living on the Ethereum blockchain. Your Bored Ape doubles as your Yacht Club membership card, and grants access to members-only benefits, the first of which is access to THE BATHROOM, a collaborative graffiti board. Future areas and perks can be unlocked by the community through roadmap activation. Visit www.BoredApeYachtClub.com for more details.",
            "tokenCount":"10000",
            "onSaleCount":"359",
            "floorAskPrice":70.99,
            "floorPrice":{
                "symbol":"ETH",
                "icon":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png",
                "value":70.99
            },
            "volume":{
                "1day":3214.9985,
                "7day":43249.40795,
                "30day":74316.84229,
                "allTime":1062155.90567
            },
            "volumeChange":{
                "1day":0.5175934773853805,
                "7day":3.064792334531978,
                "30day":1.5204050348567173
            },
            "isVerified":true
        }
    ],
    "total":97
}

Get Orders

GET https://open-api.openocean.finance/nft/v2/:chain/orders

Query Parameters

Name

Type

Description

chain

String

eth, avax, polygon, arbitrum, optimism, solana

limit

number

pagination limit(max 50)

offset

String

pagination(response next)

sort

String

floorAskPrice ascending

filters*

object

filters={address,searchAttributes,market}

address is required

amount

object

sudoswap needs this field, the initialization interface is {}, and the later refresh needs to pass the value,key-poolId (the id of the pool, returned by the orders interface), amount-the number of selected nft (default is 0)

{
    "code":0,
    "data":[
        {
            "id":"0x4bfbc9593399323db54622d11a1456087c5037cb421c803dd59d74db20c8ee0e",
            "contract_address":"0x6187e7a47cebf45b307bf70d109ce343f60d2366",
            "collection":{
                "id":"0x6187e7a47cebf45b307bf70d109ce343f60d2366",
                "name":"RSTLSS ✕ CrypToadz",
                "image":"https://api.reservoir.tools/assets/v1?asset=d13dd00e722beffaf6c818fc35b7e75a0f01e25b25369d0f19bf2607ea756be739a9e5422975cef28aa5de22a273ef3a565924c4b60594d7f177802d4085e225d21f2912380356fce460d6243ce8e26f2573e7e40288fee9530d283ebd0a413d",
                "slug":"rstlss-cryptoadz"
            },
            "token_id":"1339",
            "name":"RSTLSS x CrypToadz #7053",
            "schema_name":"erc721",
            "market":"opensea",
            "price":"116000000000000000",
            "owner":"0x849213bb7f84bb720ede09ec8273f036f00ef4af",
            "status":"",
            "image_url":"https://api.reservoir.tools/assets/v1?asset=d13dd00e722beffaf6c818fc35b7e75a792a6b2d8fb6b393c2b54fc2b994ae2f3f577808e73f3f1ab37f59dd24d53e88027883b37aebf99b4592c4e797c1ae97ea4ed5a4d740f5709928267c775f4eff2573e7e40288fee9530d283ebd0a413d",
            "traits":[

            ],
            "code":"eyJzb3VyY2UiOiJpbmRleGVyIiwib3JkZXJJZCI6IjB4NGJmYmM5NTkzMzk5MzIzZGI1NDYyMmQxMWExNDU2MDg3YzUwMzdjYjQyMWM4MDNkZDU5ZDc0ZGIyMGM4ZWUwZSIsIm93bmVyIjoiMHg4NDkyMTNiYjdmODRiYjcyMGVkZTA5ZWM4MjczZjAzNmYwMGVmNGFmIiwicHJpY2UiOiIxMTYwMDAwMDAwMDAwMDAwMDAiLCJwb29sSWQiOm51bGx9",
            "paymentAsset":{
                "symbol":"ETH",
                "address":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                "decimals":18,
                "image":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png"
            },
            "isFlagged":false
        }
    ],
    "next":"eyJyZXNlcnZpZXIiOiJNVE0wT1RBd01EQXdNREF3TURBd01EQXdYekI0TmpFNE4yVTNZVFEzWTJWaVpqUTFZak13TjJKbU56QmtNVEE1WTJVek5ETm1OakJrTWpNMk5sODBPVGc9In0"
}

Get NFT info

GET https://open-api.openocean.finance/nft/v1/:chain/detail

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

amount

number

The number of selected nft in the pool, required by sudoswap

code

String

orders/nfts code

tokenId

String

address*

String

nft contract

{
    "code":0,
    "message":"ok",
    "data":{
        "contract_address":"0x6187e7a47cebf45b307bf70d109ce343f60d2366",
        "collection":{
            "id":"0x6187e7a47cebf45b307bf70d109ce343f60d2366",
            "name":"RSTLSS ✕ CrypToadz",
            "image":"https://api.reservoir.tools/assets/v1?asset=d13dd00e722beffaf6c818fc35b7e75a0f01e25b25369d0f19bf2607ea756be739a9e5422975cef28aa5de22a273ef3a565924c4b60594d7f177802d4085e225d21f2912380356fce460d6243ce8e26f2573e7e40288fee9530d283ebd0a413d",
            "slug":"rstlss-cryptoadz"
        },
        "name":"RSTLSS x CrypToadz #7053",
        "image_url":"https://api.reservoir.tools/assets/v1?asset=d13dd00e722beffaf6c818fc35b7e75a792a6b2d8fb6b393c2b54fc2b994ae2f3f577808e73f3f1ab37f59dd24d53e88027883b37aebf99b4592c4e797c1ae97ea4ed5a4d740f5709928267c775f4eff2573e7e40288fee9530d283ebd0a413d",
        "schema_name":"erc721",
        "symbol":"",
        "description":"A small, warty, amphibious creature that resides in the metaverse.",
        "token_traits":[
            {
                "key":"Garment Artist",
                "kind":"string",
                "value":"RSTLSS",
                "tokenCount":1825,
                "onSaleCount":215,
                "floorAskPrice":0.116,
                "topBidValue":null,
                "createdAt":"2023-02-26T00:51:20.661Z"
            }
        ],
        "token_id":"1339",
        "paymentAssets":[
            {
                "id":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                "symbol":"ETH"
            }
        ],
        "isMakeOffer":false,
        "owner":{
            "address":"0x849213bb7f84bb720ede09ec8273f036f00ef4af"
        },
        "orders":[
            {
                "market":"opensea",
                "priceUsd":190.30759,
                "price":0.116,
                "end_at":1679794525000,
                "amount":"1",
                "code":"eyJzb3VyY2UiOiJpbmRleGVyIiwib3duZXIiOiIweDg0OTIxM2JiN2Y4NGJiNzIwZWRlMDllYzgyNzNmMDM2ZjAwZWY0YWYiLCJub25jZSI6IjB4MmM3NTIzZWNjMTk4ODMzNGViNzI5YjU5MmFhZWI4ZjIxY2I2YTEwZTQ3MGUzNmYzOGQxOGRlOGMwMjZkMmQ2NTM2MDgyODVkOWQxNjIzZmYxZGFjZTFkMTVlOTU5NTk1NjM5M2E2MDMyYzczNThiNmYyOTY0MjdiOWU5ODBhZTExYiIsInRpbWUiOiIiLCJwcmljZSI6IjExNjAwMDAwMDAwMDAwMDAwMCIsIm9yZGVySWQiOiIweDRiZmJjOTU5MzM5OTMyM2RiNTQ2MjJkMTFhMTQ1NjA4N2M1MDM3Y2I0MjFjODAzZGQ1OWQ3NGRiMjBjOGVlMGUifQ",
                "paymentAsset":{
                    "symbol":"ETH",
                    "address":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                    "decimals":18,
                    "image":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png"
                }
            }
        ],
        "isFlagged":false
    }
}

Get Token Quote

POST https://open-api.openocean.finance/nft/v1/:chain/quote

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

address*

String

from token(ERC20 + ETH)

amount*

number

token amount(with decimals)

to*

String

to token

{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
            "amount": 1500000000000000000,
            "outAmount": "3241563615936904222198",
            "estimatedGas": "180452"
        }
    ]
}

Owner NFTs

GET https://open-api.openocean.finance/nft/v1/:chain/nfts?address=0x&cursor=1

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

address*

String

wallet address

cursor

number

pagination

limit

number

pagination limit(max 20)

{
    "code":0,
    "data":[
        {
            "contract_address":"0x76be3b62873462d2142405439777e971754e8e77",
            "token_id":"10397",
            "image_url":"https://api.reservoir.tools/assets/v1?asset=d13dd00e722beffaf6c818fc35b7e75aff273573f7e983ee7f02c6451a94960fc23a0129d686a51c2fa086b5362ac0e4de53e27c219ffea7247f67f500dc8541ea4ed5a4d740f5709928267c775f4eff2573e7e40288fee9530d283ebd0a413d",
            "collection_slug":"",
            "name":"Mantis Corsair",
            "tokenAmount":"2",
            "schema_name":"erc1155",
            "on_sale":false,
            "floorPrice":"1090000000000000",
            "collection_name":"Parallel Alpha",
            "last_sale":"1250000000000000",
            "code":"eyJzb3VyY2UiOiJpbmRleGVyIiwib3duZXIiOiIweDcyZjE2Q2FlOEY1MEFkNjE1QUI1QThlMjMxQTQ5NmIyYWNlNTI1MzIifQ",
            "paymentAsset":{
                "symbol":"ETH",
                "address":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                "decimals":18,
                "image":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png"
            }
        }
    ],
    "next":2
}

Owner Offers

GET https://open-api.openocean.finance/nft/v1/:chain/offers

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

address*

String

wallet address

limit

number

pagination limit(max 20)

offset

String

pagination(response next)

{
    "code": 0,
    "message": "ok",
    "data": [],
    "next": ""
}

Cancel Order

POST https://open-api.openocean.finance/nft/v1/:chain/cancel

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

sender*

String

wallet address

code*

String

orders/nfts code

signature

String

only x2y2

market*

String

opensea/x2y2/looksrare

tokenId*

String

address*

String

nft contract

{
    "code": 0,
    "message": "ok",
    "data": {
        "from": "0x1cad209a2022747a0c1c538ee7d99fd1060fd378",
        "data": "0x09ba153d00000000000000000000000000000000000000000...",
        "to": ""
    }
}

Check order state

POST https://open-api.openocean.finance/nft/v1/:chain/order/state

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

orders*

array

order list

{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "market":"looksrare", // marketplace
            "tokenType":"ERC721",
            "collection":"0x4E1f41613c9084FdB9E34E11fAE9412427480e56", // nft contract
            "tokenId":"3048",
            "code": "",
            "amount":1,
            "expired": true
        },
        {
            "market":"x2y2",
            "tokenType":"ERC721",
            "collection":"0xc377b4fe503afea2573daf49c200a17c4160e14d",
            "tokenId":"3258",
            "code": "",
            "amount":1,
            "expired": false
        }
    ]
}

Sudoswap refresh order price

POST https://open-api.openocean.finance/nft/v1/:chain/refreshPrice

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

{
    "code": 200,
    "data": {
         "0x16f71d593bc6446a16ef84551cf8d76ff5973db1": "7918529411764705746", // key - poolId, value - price
    }
}

Get Token Swap

POST https://open-api.openocean.finance/nft/v1/:chain/swap

Path Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

Request Body

Name

Type

Description

sender*

String

wallet address

tokens*

array

token list(ERC20 + ETH)

{
    "code": 0,
    "message": "ok",
    "data": [
        {
            "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
            "to": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
            "amount": "4986678460420321202",
            "outAmount": "3616385441300520",
            "estimatedGas": "179198"
        }
    ]
}

Owner Listings

GET https://open-api.openocean.finance/nft/v1/:chain/listings

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

limit

number

pagination limit(max 20)

cursor

number

pagination

address*

String

wallet address

{
    "code":0,
    "data":[
        {
            "contract_address":"0xa4f47f8e2579f45c0a6e26d5fb69f8a1b027b8ca",
            "token_id":"46",
            "image_url":"https://api.reservoir.tools/assets/v1?asset=36109e01a0f463f89d0054dfb865c355814e73000779cff19c745153c0940b62a0f6d6d162252b5f90714cee0e30660fce6fe590d90bf6b892a15dfd9af35e9601bbc70db8e553c04fb623854ffb7660a28dbde39d9a236c6012977fd5349b7d0cb5844c1c3141ae520ad93de034a37d309d0ed3529d6d5c05f877658432d931",
            "collection_slug":"testnnft-v2",
            "name":"Thump - Common",
            "schema_name":"erc721",
            "tokenAmount":0,
            "on_sale":true,
            "market":"opensea",
            "orderType":"listing",
            "floorPrice":0,
            "price":"220000000000000",
            "amount":"1",
            "collection_name":"testNNFT V2",
            "last_sale":"100000000000000",
            "end_at":1679033127000,
            "code":"eyJzb3VyY2UiOiJpbmRleGVyIiwib3duZXIiOiIweDcyZjE2Q2FlOEY1MEFkNjE1QUI1QThlMjMxQTQ5NmIyYWNlNTI1MzIiLCJub25jZSI6IjB4ZDY3ZWE2ZWY5ODM2OGI2ZDNhMWFkNzJkOTdkNTk2ZDZhNzhhNmNkNDEwMWU1MmNlNGI5YmEzMjAzYmQwNGViMTQ2ZTIxNzY5NGFhMmE1MzlmYjdiNmQ5Y2JmOWZjZjE4MjJkNmRkOWZmNTU2ZGJjNDBiN2NhNmYwOTQ4MTdkZmIxYyIsInRpbWUiOiIiLCJwcmljZSI6IjIyMDAwMDAwMDAwMDAwMCIsIm9yZGVySWQiOiIweGM4NWExOWRiMDkwYzM4YjdkZDJhZGRmMmUzMzU5ZTY2NGY3MDU1YmRiZTU3ZjFmMGM0MDU1MjU5ZmU2YTg5Y2MiLCJvcmRlclR5cGUiOiJsaXN0aW5nIn0",
            "paymentAsset":{
                "symbol":"ETH",
                "address":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
                "decimals":18,
                "image":"https://cloudstorage.openocean.finance/images/1637894743832_8242841824007741.png"
            }
        }
    ],
    "next":null
}

Get collection activity

GET https://open-api.openocean.finance/nft/v1/:chain/collection/activity

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

limit

number

pagination limit(max 20)

cursor

number

pagination

tokenId

String

nft id

collectionSlug

String

collection slug(Required for non-eth chains)

collection*

String

nft contract

{
    "code":200,
    "data":[
        {
            "type":"sale",
            "fromAddress":"0xa879683c83bd76ff3369a063ebf250065d4df0a9",
            "toAddress":"0x520b12c94ce6f6c4efdea594969b5259df315441",
            "price":0.0035,
            "amount":1,
            "timestamp":1677476315,
            "token":{
                "tokenId":"675111",
                "tokenName":"Bag #675111",
                "tokenImage":"https://openseauserdata.com/files/d5ca96a8d71959a1f82ea05675fe44ea.svg"
            },
            "collection":{
                "collectionId":"0x1dfe7ca09e99d10835bf73044a23b73fc20623df",
                "collectionImage":null,
                "collectionName":"More Loot"
            },
            "txHash":"0xa4ad8566d5b843f521b1aac5e4e3b0aec380df7e55df8537672818402529d81b",
            "logIndex":69,
            "batchIndex":1,
            "source":{
                "domain":"element.market",
                "name":"element.market",
                "icon":"https://www.element.market/resource/images/favicon-180.png"
            }
        }
    ]
}

Owner Activity

GET https://open-api.openocean.finance/nft/v1/:chain/address/activity

Query Parameters

Name

Type

Description

chain*

String

eth, avax, polygon, arbitrum, optimism, solana

limit

number

pagination limit(max 20)

cursor

number

pagination

address*

String

wallet address

{
    "code":200,
    "data":[
        {
            "type":"ask",
            "fromAddress":"0x72f16cae8f50ad615ab5a8e231a496b2ace52532",
            "toAddress":null,
            "price":0.0038,
            "amount":1,
            "timestamp":1676965006,
            "token":{
                "tokenId":"10193",
                "tokenName":"Change of Heart",
                "tokenImage":"https://i.seadn.io/gcs/files/311f64e7ecc5c39aacdb1d48d40fe819.png?w=500&auto=format"
            },
            "collection":{
                "collectionId":"0x76be3b62873462d2142405439777e971754e8e77",
                "collectionImage":"https://i.seadn.io/gae/Nnp8Pdo6EidK7eBduGnAn_JBvFsYGhNGMJ_fHJ_mzGMN_2Khu5snL5zmiUMcSsIqtANh19KqxXDs0iNq_aYbKC5smO3hiCSw9PlL?w=500&auto=format",
                "collectionName":"Parallel Alpha"
            }
        }
    ]
}

Last updated 3 months ago