Introduction
  • All listed API endpoints are paginated, returning 100 items per page starting at page 1
  • Successful responses have the following JSON structure: {"total_pages": ..., "total_items": ..., "items": [ {...}, ...] }
  • Unsuccessful responses either return the 400 or 404 HTTP status code
  • Additionally the 429 status code might be added to the list depending on whether or not ratelimiting is neccessary (hopefully not, fingers crossed)
  • Lastly, if you enjoy this project make sure to also star it on GitHub <3
/v1/signatures/text/{kind}/{query}/{page}

Returns a paginated list of signatures where

  • kind is either function, event, error or all
  • query is the signatures starting text representation (at least 3 characters long)
  • page is the page index, starting at 1

Example: api.etherface.io/v1/signatures/text/all/balanceOf/1 returns all signatures starting with balanceOf (case sensitive!)

/v1/signatures/hash/{kind}/{query}/{page}

Returns a paginated list of signatures where

  • kind is either function, event, error or all
  • query is the signature hash (either 8 or 64 characters long, excluding the 0x head which is also optional)
  • page is the page index, starting at 1

Example: api.etherface.io/v1/signatures/hash/all/70a08231/1 returns all signatures starting with the hash 70a08231 (case sensitive!)

/v1/sources/github/{kind}/{id}/{page}

Returns a paginated list of GitHub repositories ordered by their stargazers where

  • kind is either function, event, error or all
  • id is the signatures internal ID, obtained by the /v1/signatures/{text,hash} endpoints
  • page is the page index, starting at 1

Example: api.etherface.io/v1/sources/github/all/7/1 returns all GitHub repositories which contain the balanceOf(address) signature / 70a08231 hash

/v1/sources/etherscan/{kind}/{id}/{page}

Returns a paginated list of Etherscan addresses ordered by their added date where

  • kind is either function, event, error or all
  • id is the signatures internal ID, obtained by the /v1/signatures/{text,hash} endpoints
  • page is the page index, starting at 1

Example: api.etherface.io/v1/sources/etherscan/all/7/1 returns all Etherscan addresses which contain the balanceOf(address) signature / 70a08231 hash