Skip to content

Latest commit

 

History

History
265 lines (201 loc) · 12.1 KB

api-reference.md

File metadata and controls

265 lines (201 loc) · 12.1 KB

API Reference

Base URL

Production: https://mainnet-node.like.co

Testnet: https://node.testnet.like.co

LCD API

Please refer to x/nft query definition and likenft query definition for most updated LCD API

Balance

queries the number of NFTs of a given class owned by the owner, same as balanceOf in ERC721

/cosmos/nft/v1beta1/balance/{owner}/{class_id}

Owner

queries the owner of the NFT based on its class and id, same as ownerOf in ERC721 /cosmos/nft/v1beta1/owner/{class_id}/{id}

Supply

queries the number of NFTs from the given class, same as totalSupply of ERC721. /cosmos/nft/v1beta1/supply/{class_id}

NFTs

queries all NFTs of a given class or owner, choose at least one of the two, similar to tokenByIndex in ERC721Enumerable

/cosmos/nft/v1beta1/nfts

NFT

queries an NFT based on its class and id.

/cosmos/nft/v1beta1/nfts/{class_id}/{id}

Class

queries an NFT class based on its id

/cosmos/nft/v1beta1/classes/{class_id}

Classes

queries all NFT classes

/cosmos/nft/v1beta1/classes

Indexer API

Pagination params:

Param Example Description
key Key of the last item of previous response for pagination, should not be used with offset
limit The size limit of response. Default & max: 100
reverse Sorting order
offset Offset of response, should not be used with key

Class API

/likechain/likenft/v1/class

ParamExampleDescription
iscn_id_prefixISCN prefix of NFT class (if minted via ISCN)
accountAccount of NFT class (if minted via account)
iscn_ownerQuery classes owned via ISCN by an address
expandexpand NFT info

NFT API

/likechain/likenft/v1/nft

ParamExampleDescription
ownerOwner address
expand_classesExpand class information

Owner API

/likechain/likenft/v1/owner

ParamExampleDescription
class_idNFT Class ID

Event API

/likechain/likenft/v1/event

ParamExampleDescription
class_idNFT Class ID
nft_idNFT ID
iscn_id_prefixISCN ID Prefix (if minted via ISCN)
verboseExpand events
action_type/cosmos.nft.v1beta1.MsgSendFilter event by action
senderGet all events sent by an address
receiverGet all events received by an address
creatorGet all events of NFT Classes created (ISCN owner) by an address
involverGet all events involving an address (sender OR receiver OR creator)
ignore_from_listIgnore events sent from address
ignore_to_listIgnore events sent to address

Ranking API

/likechain/likenft/v1/ranking

Request Params

ParamExampleDescription
creatorlike13f4glvg80zvfrrs7utft5p68pct4mcq7t5atf6The current owner of the ISCN
collectorlike1vymrc5dxlfwff30m03prwlu08ql4vudn4lue8uThe current owner of NFT
typeCreativeWorkThe contentMetadata.@type field in ISCN
stakeholder_iddid:like:1w6es6du93xmhms60gwwtczr2p2h4cdm8r7kc0fThe stakeholders.entity.@id field in ISCN
stakeholder_namekinThe stakeholders.entity.name field in ISCN
created_after1659283200Get NFT class created after this UNIX second timestamp
created_before1659801600Get NFT class created before this UNIX second timestamp
sold_after1659283200Rank NFT class base on sales after this UNIX second timestamp
sold_before1659801600Rank NFT class base on sales before this UNIX second timestamp
include_ownertrueWhether to include owner of ISCN when counting sold_count
ignore_listlike17m4vwrnhjmd20uu7tst7nv0kap6ee7js69jfrsThe addresses to ignore when counting sold count
order_bytotal_sold_value/sold_count

Result is order by the number of NFTs not owned by creator nor ignore_list

Example Response

/likechain/likenft/v1/ranking?ignore_list=like17m4vwrnhjmd20uu7tst7nv0kap6ee7js69jfrs&limit=1

{
  "classes": [
    {
      "id": "likenft1yhsps5l8tmeuy9y7k0rjpx97cl67cjkjnzkycecw5xrvjjp6c5yqz0ttmc",
      "name": "Writing NFT - 分散式出版 DePub 的發展路徑,NFT 從移民到原住民",
      "description": "...",
      "symbol": "WRITING",
      "uri": "https://api.like.co/likernft/metadata?iscn_id=iscn%3A%2F%2Flikecoin-chain%2FIKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo%2F3",
      "uri_hash": "",
      "config": {
        "burnable": false,
        "max_supply": "0",
        "blind_box_config": null
      },
      "metadata": {
        "url": "https://ckxpress.com/nft-immigrant-to-native/",
        "name": "分散式出版 DePub 的發展路徑,NFT 從移民到原住民",
        "@type": "Article",
        "image": "ar://_GJD1gNuIqXicYNWce__4B8Qqg5tN8FBRSUCXR8kuJE",
        "version": 1,
        "@context": "http://schema.org/",
        "keywords": "DePub,LikeCoin,nft,Numbers",
        "usageInfo": "",
        "description": "...",
        "nft_meta_collection_id": "likerland_writing_nft",
        "nft_meta_collection_name": "Writing NFT",
        "nft_meta_collection_description": "Writing NFT by Liker Land"
      },
      "parent": {
        "type": "ISCN",
        "iscn_id_prefix": "iscn://likecoin-chain/IKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo",
        "account": ""
      },
      "price": 0,
      "created_at": "2022-08-01T06:33:21Z",
      "sold_count": 171
    }
  ],
  "pagination": {
    "count": 1
  }
}

Note: Currently only like.co API can report the latest price. price in the response is always 0. Please refer to like.co API documentation for price information


Social Graph API

Get Collectors

/likechain/likenft/v1/collector

Param Example Description
creator like13f4glvg80zvfrrs7utft5p68pct4mcq7t5atf6 Required. Account address of ISCN owner
ignore_list The addresses to ignore
include_owner Whether to include owner of ISCN
price_by class/nft
order_by price/count

Get Creators

/likechain/likenft/v1/creator

Param Example Description
collector like13f4glvg80zvfrrs7utft5p68pct4mcq7t5atf6 Required. Account address of NFT owner
ignore_list The addresses to ignore
include_owner Whether to include owner of ISCN
price_by class/nft
order_by price/count

Result is order by count of NFT collections.

Example Response

/likechain/likenft/v1/collector?creator=like13f4glvg80zvfrrs7utft5p68pct4mcq7t5atf6

{
  "collectors": [
    {
      "account": "like17m4vwrnhjmd20uu7tst7nv0kap6ee7js69jfrs",             // The like.co NFT sales API wallet
      "count": 2928,
      "collections": [
        {
          "iscn_id_prefix": "iscn://likecoin-chain/IKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo",
          "class_id": "likenft1yhsps5l8tmeuy9y7k0rjpx97cl67cjkjnzkycecw5xrvjjp6c5yqz0ttmc",
          "count": 443
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/IKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo",
          "class_id": "likenft1yzdfkf4fjjekqjmxen0czy5eyufapfrx5y3nd6d7wd6hmyy6zt3sk7ak4z",
          "count": 500
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/OImbeoC6JTlEJrjVOJXAj4rF5uS04vuRGbittFGyQbc",
          "class_id": "likenft1h9efvdvj5m275w8sr2u0jsme2xlmpfexjp802ckda3fvuncw95tsnq2c7u",
          "count": 492
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/Tz4l66fBAgEMk5IyEJ4_N0FBj2NjLCse3Uqnm8VxR-8",
          "class_id": "likenft1g0652jc6fns73r5ru6pwp6djp99975em576px88wxau7hrmn2d5qf06zs4",
          "count": 500
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/Tz4l66fBAgEMk5IyEJ4_N0FBj2NjLCse3Uqnm8VxR-8",
          "class_id": "likenft1yhxut65wavj2jykq07xtm66dnmn75dm5y0tgq8f49azs3lff7ngqrw7kv6",
          "count": 500
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/Tz4l66fBAgEMk5IyEJ4_N0FBj2NjLCse3Uqnm8VxR-8",
          "class_id": "likenft1ztyc5usfn36r2uuza86waa7xn9j7r8xjzagtpcesj3p2t7mmj9kssqlxwe",
          "count": 493
        }
      ]
    },
    {
      "account": "like126qel5qhcxnxy2nd0s43pjp2aqujnp60jeg27l",
      "count": 3,
      "collections": [
        {
          "iscn_id_prefix": "iscn://likecoin-chain/IKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo",
          "class_id": "likenft1yhsps5l8tmeuy9y7k0rjpx97cl67cjkjnzkycecw5xrvjjp6c5yqz0ttmc",
          "count": 1
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/OImbeoC6JTlEJrjVOJXAj4rF5uS04vuRGbittFGyQbc",
          "class_id": "likenft1h9efvdvj5m275w8sr2u0jsme2xlmpfexjp802ckda3fvuncw95tsnq2c7u",
          "count": 1
        },
        {
          "iscn_id_prefix": "iscn://likecoin-chain/Tz4l66fBAgEMk5IyEJ4_N0FBj2NjLCse3Uqnm8VxR-8",
          "class_id": "likenft1ztyc5usfn36r2uuza86waa7xn9j7r8xjzagtpcesj3p2t7mmj9kssqlxwe",
          "count": 1
        }
      ]
    },
    {
      "account": "like18q3dzavq7c6njw92344rf8ejpyqxqwzvhz9th5",
      "count": 3,
      "collections": [
        {
          "iscn_id_prefix": "iscn://likecoin-chain/IKI9PueuJiOsYvhN6z9jPJIm3UGMh17BQ3tEwEzslQo",
          "class_id": "likenft1yhsps5l8tmeuy9y7k0rjpx97cl67cjkjnzkycecw5xrvjjp6c5yqz0ttmc",
          "count": 3
        }
      ]
    }
  ],
  "pagination": {
    "count": 3
  }
}

Example UI

https://likecoin.github.io/likecoin-nft-dashboard/

source code

\