API Documentation
Access and submit reports via API for free. Contact us if you have any issues or questions on using our API. We'll try and respond within 24 hours.
Endpoints
- Report Scammer
- Search Result With Exact Match
- Search Result With Wild Card
- api_token - Required. Get your API key.
- bitcoinaddress - Required
- scammertype - Required. . See create report form to Scam Type Field.
- scammertype_other - Required if Scam Type is (other).
- scammerusername
- scammeremail
- scammerphone
- scamdescription - Required
- api_token - Required. Get your API key.
- type - Required (all/email/user/address/phone)
- search - Required
- api_token - Required. Get your API key.
- type - Required (all/email/user/address/phone)
- search - Required
All endpoints have a rate limit of 30 requests per minute or one request every two seconds on average. If you need a higher rate limit please contact us. To gain access to our API's you must register an account to get a free API key.
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.scamsearch.io/api/
followed by ?first=abc&second=xzy
)
Learn more
Report Address
The Report Address API allows you to report bitcoin addresses automatically.
POST https://scamsearch.io/api/create_report
Parameters
Search With Exact Match
GET https://scamsearch.io/api/search?
search={search_string}
&type={all/email/user/address/phone}
&api_token={API_TOKEN}
This report is cached and only updates once per hour.
Parameters
Search With Wild Card
GET https://scamsearch.io/api/search-with-wild?
search={search_string}
&type={all/email/user/address/phone}
&api_token={API_TOKEN}
This report is cached and only updates once per hour.