AdsGuard

Developer API

Authenticate using an API key sent in the X-API-Key header. You can manage your API keys in your account settings.

Authentication

Include your API key in the X-API-Key header on every request. Never hardcode keys in source control; prefer environment variables.

curl -s \
  -H 'X-API-Key: <YOUR_API_KEY>' \
  https://adsguard.site/api/v1/ads-txt/example.com/check

Check ads.txt

GET /api/v1/ads-txt/{domain}/check

curl -s \
  -H 'X-API-Key: <YOUR_API_KEY>' \
  https://adsguard.site/api/v1/ads-txt/example.com/check

Response

{
  "domain": "example.com",
  "adsTxtUrl": "https://example.com/ads.txt",
  "content": "<raw ads.txt content>",
  "warnings": [
    { "code": "DEPRECATED_FIELD", "message": "...", "line": 12 }
  ],
  "errors": [
    { "code": "INVALID_DOMAIN", "message": "...", "line": 3 }
  ],
  "summary": {
    "isValid": true,
    "compliance": "good",
    "score": 95,
    "validRecords": 42,
    "invalidRecords": 1
  }
}

List versions

GET /api/v1/ads-txt/{domain}/versions

curl -s \
  -H 'X-API-Key: <YOUR_API_KEY>' \
  https://adsguard.site/api/v1/ads-txt/example.com/versions

Response

{
  "domain": "example.com",
  "versions": [
    { "id": "abc123", "createdAt": "2025-09-01T12:34:56.000Z", "checksum": "e3b0c4...", "size": 1234 },
    { "id": "def456", "createdAt": "2025-08-20T09:22:10.000Z", "checksum": "a1b2c3...", "size": 1201 }
  ]
}

Diff versions

GET /api/v1/ads-txt/{domain}/diff?v1=<versionId1>&v2=<versionId2>

curl -s \
  -H 'X-API-Key: <YOUR_API_KEY>' \
  'https://adsguard.site/api/v1/ads-txt/example.com/diff?v1=ABC&v2=DEF'

Response

{
  "domain": "example.com",
  "v1": "abc123",
  "v2": "def456",
  "summary": { "changes": 3 },
  "changes": [
    { "index": 4, "right": "google.com, pub-123, DIRECT, f08c47fec0942fa0", "type": "added" },
    { "index": 9, "left": "foo.com, 999, DIRECT", "type": "removed" },
    { "index": 12, "left": "bar.com, 111, DIRECT", "right": "bar.com, 222, DIRECT", "type": "changed" }
  ]
}

Notes:

  • All responses are JSON.
  • Rate limits may apply.