ScamMinder REST API Documentation

Overview

The Scam Minder REST API provides a comprehensive suite of tools for website analysis and scam detection. It offers various endpoints for retrieving detailed information about websites, including scam scores, WHOIS data, content analysis, and more.

Base URL

All API requests should be made to the following base URL:

https://scamminder.com/rest-api

Authentication

API requests require an authorization token to be included in the header of each request. The token should be obtained and included as follows:

Authorization: Bearer YOUR_ACCESS_TOKEN

Endpoints

1. Full Data

  • Endpoint: /full_data
  • Method: POST
  • Description: Retrieves comprehensive information about a specified website.
  • Parameters:
    • website (required): URL of the website to analyze.
    • callback (optional): Callback URL for asynchronous response.

2. IP Data

  • Endpoint: /ip_data
  • Method: POST
  • Description: Provides data related to the IP address of the website.
  • Parameters:
    • website (required)
    • callback (optional)

… [similar structure for other endpoints]

9. AI Grammar

  • Endpoint: /ai_grammar
  • Method: POST
  • Description: Analyzes the grammar and readability of website content.
  • Parameters:
    • website (required)
    • callback (optional)

10. Scam Score

  • Endpoint: /scam_score
  • Method: POST
  • Description: Returns a scam score indicating the likelihood of the website being fraudulent.
  • Parameters:
    • website (required)
    • callback (optional)

11. Scam Status

  • Endpoint: /scam_status
  • Method: POST
  • Description: Provides a status report on whether a site is marked as a scam.
  • Parameters:
    • website (required)
    • callback (optional)

12. WHOIS Data

  • Endpoint: /whois_data
  • Method: POST
  • Description: Retrieves WHOIS information of the specified website.
  • Parameters:
    • website (required)
    • callback (optional)

Making a Request

To make a request to the Scam Minder API, you need to send a POST request with the appropriate parameters. Here is a sample PHP code to make a request:

PHP
$url = "https://scamminder.com/rest-api/ENDPOINT"; // Replace ENDPOINT with the desired endpoint

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
   "Authorization: Bearer YOUR_ACCESS_TOKEN", // Replace with your access token
   "Content-Type: application/json",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$data = json_encode(array("website" => "https://example.com", "callback" => "https://yourcallbackurl.com"));
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

Note: Replace "ENDPOINT" with the appropriate endpoint and ensure all required parameters are included in the $data array.

Response Format

Responses from the Scam Minder API are returned in JSON format. Each response includes a status code indicating the success or failure of the request, along with the requested data or an error message.

Error Handling

In case of an error, the API will return a JSON object containing an error code and a descriptive message.