SolidStamp API Reference

Overview

Welcome to SolidStamp API! You can use this API to retrieve the list of all the audits registered at SolidStamp. You can display the audit data at Ethereum Wallets, Exchanges or Blockchain Explorers to inform the end-users whether a particular smart contract was audited and who performed the audit. Such additional information allows end-users to make an educated decision about interacting with a smart contract.

Click here to see an example of the SolidStamp API integrated with Trivial.co (Go to Details & Metrics tab and scroll down).

Authentication

Authentication is done via an API key. Contact us to receive your API key. You can use the test API Key e9958a53ceb624a160a98f851 while testing. Note: it returns 2 audits only.

Requests are authenticated using HTTP Basic Auth. Provide your API key as the bearer token in an Authorization header.

curl https://www.solidstamp.com/api/audits?tokens_only=false -H 'Authorization: Bearer e9958a53ceb624a160a98f851'

Parameters:

tokens_only
true if you want to receive audits corresponding with token contracts only, false otherwise (default false)

Audits response

The /api/audits responds with a list of contract addresses:

{ "addresses": [ { "address": "0x4c382F8E09615AC86E08CE58266CC227e7d4D913", "audits": [ { "is_approved": null, "text": "Audited by Sigma Prime", "auditor_name": "Sigma Prime", "learn_more_url": "https://www.solidstamp.com/contract/0x4c382F8E09615AC86E08CE58266CC227e7d4D913", "auditor_logo_url": "https://www.solidstamp.com/media/avatars/RjzC90P_.jpg" }, / ... / ] }, / ... / ] }

The following attributes are present in the response:

addresses
array
List of the addresses of the audited smart contracts
address
string
Ethereum address (with checksum) in hex
audits
array
List of the audits of the particular address
is_approved
boolean
Besides auditing the contract, the auditors can additionally approve (stamp) it or reject it. The attribute is true if the auditor approved (stamped) the contract, false if the contract was rejected. It is null if the auditor neither approved (stamped) nor rejected the contract. Learn more at our FAQ
text
string
Exemplary text label that can be displayed on the partner website
auditor_name
string
Name of the auditor who performed the audit
learn_more_url
string
Url with more information about the audit
auditor_logo_url
string
Url to the auditor logo

Presentation notes

If a contract is not listed as audited, you can display "No audits registered at SolidStamp" and link to SolidStamp.

If there is more than one audit, you should display them all.

Errors

Out API returns standard HTTP success or error status codes.

Rate limiting and caching

You may make 1 request per minute to each API. Feel free to cache the results if needed.