Public API of ERC20 token informations and images.

Description

Public API of ERC20 token informations and images 🔥 Use it for free at https://token-info-api-mmhvmxdeam.now.sh

Donate

ETH: 0x1e3c6aadcf9ece27fef76d7087e2eff0f559eeb9 ❤️

Installation

$ npm install

Start

$ npm run start

Docs

Available at: http://localhost:3000/api/

Credits

• Author - Alessio Delmonti
• Website - https://www.dexlab.io/
• Informations - @Forkdelta/tokenbase
• Images - @TrustWallet/tokens

Format

Token information is stored in YAML format, one token per file, in tokens/0xTOKENADDRESS.yaml.

Common YAML

• # Comment is a YAML comment. The hash # must be preceded by a space.
• key: value is a key-value pair.
• - item is a list entry. It is possible to have a list entry of a non-scalar type, e.g.: - key: value is a list entry containing a key-value pair.

Required

A token listing file must include the following information:

---  # Mandatory "start of the document" marker
addr: '0x…'  # token contract address, in single quotes
decimals: 18 # Token decimals
name: Human Readable Token Name  # Required
symbol: TOKEN  # Required: Token symbol

Description

Description of the token can be included:

---
addr: '0x5b0751713b2527d7f002c0c4e2a37e1219610a6b'
decimals: 18
description: The World’s first DAPP to bet on the price of Cryptocurrencies
name: Horse
symbol: HORSE

If you need more than one line of description, use the folded scalar notation:

---
addr: '0x5b0751713b2527d7f002c0c4e2a37e1219610a6b'
decimals: 18
description: >-
  The World’s first DAPP to bet on the price of Cryptocurrencies

  Ethorse is an Ethereum Smart Contract based DApp for betting on the price of
  Cryptocurrencies and win from everyone who bets against you.
name: Horse
symbol: HORSE

Note that folded scalar notation requires two new lines for a paragraph break (like Reddit format).

Description may contain HTML.

Links

Links can be included to refer the user to external resources relevant to the token. They are represented by a list of key-value pairs, where key is the type of the link. The following types are currently recognized:

• Bitcointalk
• Blog
• CoinMarketCap
• Discord
• Email
• Facebook
• Github
• Reddit
• Slack
• Telegram
• Twitter
• WeChat
• Website
• Whitepaper
• YouTube

Example:

---
addr: '0x5b0751713b2527d7f002c0c4e2a37e1219610a6b'
decimals: 18
links:
- Email: mailto:[email protected]
- Telegram: https://telegram.me/ethorse
- Twitter: https://twitter.com/EthorseTeam
- Website: https://ethorse.com/
- Whitepaper: https://ethorse.com/Whitepaper.pdf
name: Horse
symbol: HORSE

Notice

Notice is a special field used to communicate critical information regarding contract or token status. This information should be prominently displayed to the user before any interaction occurs. Example:

---
addr: '0x44f12955189e3f01be5daf1dd9002ee4d774f42b'
decimals: 18
name: AfterSchool Token
notice: >-
  On October 12, Afterschool voluntarily suspended its ongoing crowdsale and will be returning all pledged ETH
  to the contributors.
  <a href="https://medium.com/afterschool/afterschool-ico-announcement-4c36b5ee45da">Read the announcement.</a>
symbol: AST

Notice may cointain HTML.