API Documentation

Lookup bitcoin addresses that have been linked to criminal activity

Endpoints

All endpoints other than Report Address have a rate limit of 30 requests per minute or one request every two seconds on average. The Report Address API has a rate limit of 1 requests per day. If you need a higher rate limit please contact us.

How GET Parameters work
GET request are used for any API request that does not have a lasting effect. For our API all endpoints use GET except the "Report Address" endpoint which uses POST. For GET requests you can append parameters to the URL with the first variable indicated by ?, second and subsequent indicated by &. (E.g. https://www.bitcoinabuse.com/api/endpoint?first=abc&second=xzy)

Learn more


Report Address

The Report Address API allows you to report bitcoin addresses automatically. This API requires permission to be used, please contact us.

POST https://www.bitcoinabuse.com/api/reports/create

Parameters
  • api_token - Required. Get your API key.
  • address - Required
  • abuse_type_id - Required. Integer. See how to lookup abuse types.
  • abuse_type_other - Required if abuse_type_id is 99 (other).
  • abuser
  • description


Lookup Abuse Type

This API allows you to look up the abuse_type_id for use with the report address API.

GET https://www.bitcoinabuse.com/api/abuse-types



Lookup Distinct Reports

GET https://www.bitcoinabuse.com/api/reports/distinct

This report is cached and only updates once per hour.

Parameters
  • api_token - Required. Get your API key.
  • page - Optional. Integer great than or equal to 1.
  • reverse - Optional. Reverse the order so oldest reports are first. Use &reverse=true


Check Address

GET https://www.bitcoinabuse.com/api/reports/check

This report is cached and only updates once per hour.

Parameters
  • api_token - Required. Get your API key.
  • address - Required
Example

https://www.bitcoinabuse.com/api/reports/check?address={ADDRESS}&api_token={API_TOKEN}



Complete Download

GET https://www.bitcoinabuse.com/api/download/{time_period}

Returns a CSV file containing all reports within the given time period. The "1d" file is updated daily in the early morning. The "30d" file is updated weekly on Sunday morning. The "forever" file is updated monthly on the 15th of the month. All updates occur between 2am-3am UTC.

Parameters
  • api_token - Required. Get your API key.
  • time_period - Required. Allowed options are 1d, 30d, or forever
Example

https://www.bitcoinabuse.com/api/download/30d?api_token={API_TOKEN}



Questions or comments? Contact us