Skip to content

API Reference.md

Jump to bottom
CIPRIAN STEFAN PLESCA edited this page Sep 2, 2026 · 1 revision

API Reference

Base path: /api/v1

Endpoints

flowchart TB
  API[API v1]
  API --> Health["GET /health"]
  API --> Check["GET /check?url="]
  API --> Report["POST /report"]
  API --> Feedback["POST /feedback"]
  API --> Domains["GET /domains?q="]
  API --> Stats["GET /stats"]
Loading

Check Response

{
  "domain": "example-broker.com",
  "score": 38,
  "riskLevel": "medium",
  "badge": "yellow",
  "reasons": [
    {
      "code": "DOMAIN_YOUNG",
      "severity": "warning",
      "detail": "Domain age is below the configured trust threshold.",
      "source": "rdap"
    }
  ],
  "checkedAt": "2026-09-02T10:00:00.000Z",
  "cacheTtlSeconds": 86400
}

Contribution and License

This repository is an open-source project and encourages contributions. Please see the CONTRIBUTING.md file for guidelines on how to report issues or submit pull requests.

MIT License

This project is licensed under the terms of the MIT License. See the LICENSE file for full details.

Copyright (c) 2024 Ciprian-LocalPulse

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (hereinafter referred to as the "Software"), to deal in the Software without restriction, including, without limitation, the rights to use, copy, modify, merge, publish, distribute, sublicense and/or sell copies of the Software, and to permit persons to whom the Software is provided to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Source Code and Issues

Clone this wiki locally