Get key for your trial
Don’t have an API key?
To begin exploring our API, simply acquire your unique API key from here.
- Use your own API key ** and try APIs in the pages
- Sign up，click“ My studio”，find and copy your own key
- Understand the status code of your request.
Tips for finding data quickly
At Footprint, we set a unique key for each entity to help us pinpoint it. inlcluding:
chain, entity_id, protocol_slug,token_slug, nft_collection_slug, marketplace_slug etc
For developers eager to hit the ground running with the Footprint Data API, here are a few quick steps to make your first call with the API.
how to get protocol_slug
Here are 3 ways to get protocl_slug：
- you know a contract address or token address, you can get protocol_slug by getProtocolMetadataByContract
curl --request GET \
--url 'https://api.footprint.network/api/v2/protocol/info/by-contract?chain=Ethereum&contract_address=0xe736cd0a683a9adec4f1abc28d4075bee808d4a1' \
--header 'accept: application/json' \
--header 'api-key: demo-api-key'
{
"message": "success",
"code": 0,
"data": [
{
"chain": "Ethereum",
"protocol_slug": "northern-guilds",
"protocol_type": "GameFi",
"protocol_sub_type": "N/A",
"protocol_name": "Northern Guilds",
"logo": "https://footprint-imgs.oss-us-east-1.aliyuncs.com/logo_images/northern-guilds.png",
"categories": [
"Action",
"Dungeon",
"MMORPG"
],
"discord": "",
"github": "",
"twitter": "",
"telegram": "",
"web_url": "https://northernguilds.com/",
"description": "Make history. Save humanity. Rule Midgard.",
"updated_at": "2023-07-20 11:40:55.000 UTC",
"created_at": "2022-07-07 15:59:00.000 UTC"
}
]
}
- you know a name, you can get protocol_slug by getProtocolMetadataByName
curl --request GET \
--url 'https://api.footprint.network/api/v2/protocol/info/by-name?chain=Ethereum&name=Northern%2520Guilds' \
--header 'accept: application/json' \
--header 'api-key: demo-api-key'
{
"message": "success",
"code": 0,
"data": [
{
"chain": "Ethereum",
"protocol_slug": "northern-guilds",
"protocol_type": "GameFi",
"protocol_sub_type": "N/A",
"protocol_name": "Northern Guilds",
"logo": "https://footprint-imgs.oss-us-east-1.aliyuncs.com/logo_images/northern-guilds.png",
"categories": [
"Action",
"Dungeon",
"MMORPG"
],
"discord": "",
"github": "",
"twitter": "",
"telegram": "",
"web_url": "https://northernguilds.com/",
"description": "Make history. Save humanity. Rule Midgard.",
"updated_at": "2023-07-20 11:40:55.000 UTC",
"created_at": "2022-07-07 15:59:00.000 UTC"
}
]
}
- you konw a token name/symbol, you can get protocol_slug by getProtocolMetadataByName
curl --request GET \
--url 'https://api.footprint.network/api/v2/protocol/info/by-name?chain=Ethereum&name=sandbox' \
--header 'accept: application/json' \
--header 'api-key: demo-api-key'
{
"message": "success",
"code": 0,
"data": [
{
"chain": "Ethereum",
"protocol_slug": "fantasy-islands-sandbox",
"protocol_type": "NFT",
"protocol_sub_type": null,
"protocol_name": "Fantasy Islands - Sandbox",
"logo": "https://lh3.googleusercontent.com/uny3zsr-9j83mBprBjJEruB9S1ViJbgMkzUZzPiLoSqnTk1XwPIO4a2P7XQASZPVTCSG3fUqpySZeBG0pKL_idM1_iv0h6GXpghxRRo=s120",
"categories": null,
"discord": null,
"github": null,
"twitter": null,
"telegram": null,
"web_url": null,
"description": null,
"updated_at": "2022-07-07 15:59:59.000 UTC",
"created_at": "2022-07-07 15:59:59.000 UTC"
},
{
"chain": "Ethereum",
"protocol_slug": "the-sandbox",
"protocol_type": "GameFi",
"protocol_sub_type": "N/A",
"protocol_name": "The Sandbox",
"logo": "https://footprint-imgs.oss-us-east-1.aliyuncs.com/logo_images/the-sandbox.jpg",
"categories": [
"Minigame",
"Open-World",
"Virtual-World"
],
"discord": "https://discordapp.com/invite/vAe4zvY",
"github": "",
"twitter": "TheSandboxGame",
"telegram": "",
"web_url": "https://www.sandbox.game/en/",
"description": "The Sandbox is a virtual gaming world where players can build, own, and monetize their gaming experiences.",
"updated_at": "2023-05-08 06:50:48.000 UTC",
"created_at": "2022-07-07 15:59:59.000 UTC"
},
{
"chain": "Ethereum",
"protocol_slug": "the-sandbox-assets",
"protocol_type": "NFT",
"protocol_sub_type": null,
"protocol_name": "The Sandbox ASSETS",
"logo": "https://lh3.googleusercontent.com/SXH8tW1siikB80rwCRnjm1a5xM_MwTg9Xl9Db6mioIk9HIlDM09pVoSR7GKJgS6ulSUpgW9BDtMk_ePX_NKgO9A=s60",
"categories": null,
"discord": null,
"github": null,
"twitter": null,
"telegram": null,
"web_url": null,
"description": null,
"updated_at": "2022-07-07 15:59:59.000 UTC",
"created_at": "2022-07-07 15:59:59.000 UTC"
}
]
}
how to get entity_id
If you know a name, you can get entity_id by getEntityList , for example:
curl --request GET \
--url 'https://api.footprint.network/api/v2/entity/getEntityList?name=dodo' \
--header 'accept: application/json' \
--header 'api-key: demo-api-key'
This request will return the results obtained through a fuzzy search by name.
{
"message": "success",
"code": 0,
"data": [
{
"entity_id": "fp-entity/dodo",
"entity_name": "dodo"
},
{
"entity_id": "fp-entity/dodo-dodo",
"entity_name": "dodo-dodo"
},
{
"entity_id": "fp-entity/zendodo-party",
"entity_name": "zendodo-party"
}
]
}
There may be multiple results, and in this case, you need to use your own experience to determine which one is the result you are looking for or try each one.