API Reference

/rug_check/{api_key}

Call into this rug_check endpoint with the Solana token address or pool address.

On success this will return status = "processed" or status = "not_processed".
For processed tokens we will indicate whether we think it is a scam.

Consumers are welcome to use the human readablemessage (which is used for our production extension) or use the raw data themselves with the fresh_percent and rug_percent.

Example responses:

{
 status: "not_processed",
 message: "Token has not been processed. This typically is due to the token not having enough trades."
}
{
  status: "processed",
  message: "88% of volume is from past rug pullers",
  is_scam: true,
  rug_percent: 0.8847474315775891,
  fresh_percent: 0.11182295987215211
}

The simplest way to use the API is to check for status == "processed" && is_scam then display to the user the message. This will alert users for rug tokens.

Language
Click Try It! to start a request and see the response here!