# Example request

curl https://adstxt.guru/api/1.0/
-d key=KEY
-d secret=SECRET


# Example authentication failed response

{
    "success": false,
    "reason": "authentication"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/invalid/
-d key=KEY
-d secret=SECRET


# Example invalid request response

{
    "success": false,
    "reason": "invalid"
}

$api = atg_api('KEY', 'SECRET');

# Example domain array

{
    "id": "1234",
    "tag": "abcdefgi01234567",
    "name": "domain.com",
    "protocol": "https",
    "verify_key": "ABCDEFGU01234567",
    "verified": "0",
    "comment": "1",
    "synchronize": "0",
    "discovery": "1"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/list/
-d key=KEY
-d secret=SECRET


# Example successful response

{
    "success": true,
    "domains": {
        "1234" {
            "id": "1234",
            "tag": "abcdefgi01234567",
            "name": "domain.com",
            "protocol": "https",
            "verify_key": "ABCDEFGU01234567",
            "verified": "0",
            "comment": "1",
            "synchronize": "0",
            "discovery": "1"
        },
        "1235" {
            "id": "1235",
            "tag": "abcdefgi01234568",
            "name": "another.com",
            "protocol": "http",
            "verify_key": "ABCDEFGU01234568",
            "verified": "1",
            "comment": "1",
            "synchronize": "1",
            "discovery": "1"
        }
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/add/
-d key=KEY
-d secret=SECRET
-d protocol=https
-d name=domain.com


# Example duplicate domain response

{
    "success": false,
    "reason": "duplicate"
}


# Example successful response

{
    "success": true,
    "domain": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "domain.com",
        "protocol": "https",
        "verify_key": "ABCDEFGU01234567",
        "verified": "0",
        "comment": "1",
        "synchronize": "0",
        "discovery": "1"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/get/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "domain": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "domain.com",
        "protocol": "https",
        "verify_key": "ABCDEFGU01234567",
        "verified": "0",
        "comment": "1",
        "synchronize": "0",
        "discovery": "1"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/edit/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d protocol=http
-d comment=0


# Example successful response

{
    "success": true,
    "domain": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "domain.com",
        "protocol": "http",
        "verify_key": "ABCDEFGU01234567",
        "verified": "0",
        "comment": "0",
        "synchronize": "0",
        "discovery": "1"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/remove/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/synchronize/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example 'Connect FTP' and 'Connect WordPress' not configured, and HTTP verification failed response

{
    "success": false,
    "reason": "noftp"
}


# Example FTP synchronize successful response

{
    "success": true,
    "method": "ftp"
}


# Example HTTP verification successful response

{
    "success": true,
    "method": "http"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/verify/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example domain group array

{
    "id": "1234",
    "group": "Example Group",
    "trust": {
        "organization": "Ad Network",
        "url": "http://example.com/"
    },
    "approved": "1"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/group/list/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "groups": {
        "123": {
            "id": "123",
            "group": "Example Group",
            "trust": {
                "organization": "Ad Network",
                "url": "http://example.com/"
            },
            "approved": "1"
        },
        "124": {
            "id": "124",
            "group": "Another Group",,
            "trust": false,
            "approved": "0"
        },
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/group/request/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d tag=abcdefgi01234567
-d message=My+publisher+account+username+is+ABC123.


# Example invalid tag response

{
    "success": false,
    "reason": "invalid-tag"
}


# Example successful response

{
    "success": true,
    "request": {
        "id": "123",
        "group": "Example Group",
        "trust": false,
        "approved": "0"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/group/remove/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d group=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example domain invite array

{
    "id": "1234",
    "group": "Example Group",
    "trust": {
        "organization": "Ad Network",
        "url": "http://example.com/"
    },
    "approved": "1",
    "message": "Request from ABC Ad Network as discussed with, john@abcads.com."
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/invite/list/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "invites": {
        "123": {
            "id": "123",
            "group": "Example Group",
            "trust": {
                "organization": "Ad Network",
                "url": "http://example.com/"
            },
            "approved": "0",
            "message": "Request from ABC Ad Network as discussed with, john@abcads.com."
        },
        "124": {
            "id": "124",
            "group": "Another Group",
            "trust": false,
            "approved": "0",
            "message": ""
        },
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/invite/approve/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d invite=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/invite/decline/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d invite=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example domain adstxt array

{
    "tag": "abcdefgi01234567",
    "type": "data",
    "name": "google.com",
    "publisher": "pub-0123456",
    "relationship": "DIRECT",
    "certification": "abcdef012345"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/list/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "adstxt": {
        "version": "0.0.1",
        "records": {
            "123": {
                "tag": "abcdefgi01234567",
                "type": "data",
                "name": "google.com",
                "publisher": "pub-0123456",
                "relationship": "DIRECT",
                "certification": "abcdef012345"
            },
            "124": {
                "tag": "abcdefgi01234568",
                "type": "variable",
                "name": "contact",
                "value": "email@domain.com"
            },
            "125": {
                "tag": "abcdefgi01234569",
                "type": "comment",
                "comment": "Example comment."
            },
            "126": {
                "tag": "abcdefgi01234560",
                "type": "collaborator",
                "name": "Example Group",
                "records": {
                    "127": {
                        "tag": "abcdefgi01234561",
                        "type": "data",
                        "name": "google.com",
                        "publisher": "pub-0123457",
                        "relationship": "RESELLER",
                        "certification": "abcdef012345"
                    }
                }
            }
        }
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/add/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d type=data
-d name=google.com
-d publisher=pub-0123456
-d relationship=DIRECT
-d certification=abcdef012345


# Example invalid record response

{
    "success": false,
    "reasons": [
        "name-invalid",
        "publisher-invalid"
    ]
}


# Example successful response

{
    "success": true,
    "id": "123",
    "tag": "abcdefgi01234567"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/edit/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d record=123
-d tag=abcdefgi01234567
-d type=data
-d name=google.com
-d publisher=pub-0123456
-d relationship=DIRECT
-d certification=abcdef012345


# Example invalid record response

{
    "success": false,
    "reasons": [
        "name-invalid",
        "publisher-invalid"
    ]
}


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/remove/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d record=123
-d tag=abcdefgi01234567


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/import/
-d key=KEY
-d secret=SECRET
-d domain=1234
-d import=google.com%2C+pub-0123456%2C+DIRECT%2C+abcdef012345%0A%23+A+Comment%0Acontact%3Demail%40domain.com


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/domain/adstxt/download/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "adstxt": "# ATG-ABCDEFGU01234567\n# Version 0.0.1\ngoogle.com, pub-0123456, DIRECT, abcdef012345\ncontact=email@domain.com"
}

$api = atg_api('KEY', 'SECRET');

# Example group array

{
    "id": "1234",
    "tag": "abcdefgi01234567",
    "name": "Example Group",
    "trusted": "0",
    "comment": "1",
    "synchronize": "0",
    "discovery": "1",
    "approve": "0"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/list/
-d key=KEY
-d secret=SECRET


# Example successful response

{
    "success": true,
    "groups": {
        "1234" {
            "id": "1234",
            "tag": "abcdefgi01234567",
            "name": "Example Group",
            "trusted": "0",
            "comment": "1",
            "synchronize": "0",
            "discovery": "1",
            "approve": "0"
        },
        "1235" {
            "id": "1235",
            "tag": "abcdefgi01234568",
            "name": "Another Group",
            "trusted": "0",
            "comment": "1",
            "synchronize": "1",
            "discovery": "1",
            "approve": "1"
        }
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/add/
-d key=KEY
-d secret=SECRET
-d name=Example Group


# Example duplicate domain response

{
    "success": false,
    "reason": "duplicate"
}


# Example successful response

{
    "success": true,
    "group": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "Example Group",
        "trusted": "0",
        "comment": "1",
        "synchronize": "0",
        "discovery": "1",
        "approve": "0"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/get/
-d key=KEY
-d secret=SECRET
-d group=1234


# Example successful response

{
    "success": true,
    "group": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "Example Group",
        "trusted": "0",
        "comment": "1",
        "synchronize": "0",
        "discovery": "1",
        "approve": "0"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/edit/
-d key=KEY
-d secret=SECRET
-d group=1234
-d comment=0
-d discovery=0

# Example successful response

{
    "success": true,
    "group": {
        "id": "1234",
        "tag": "abcdefgi01234567",
        "name": "Example Group",
        "trusted": "0",
        "comment": "0",
        "synchronize": "0",
        "discovery": "0",
        "approve": "0"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/remove/
-d key=KEY
-d secret=SECRET
-d group=1234


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/synchronize/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example 'nosuccess' response

{
    "success": false,
    "reason": "nosuccess",
    "failed_count": "5"
}


# Example successful response

{
    "success": true,
    "success_count": "5",
    "failed_count": "0"
}


# Example partially successful response

{
    "success": true,
    "success_count": "2",
    "failed_count": "3"
}

$api = atg_api('KEY', 'SECRET');

# Example group domain array

{
    "id": "1234",
    "domain": "domain.com",
    "flex": {
        "1-abcdefgi01234567": "pub-0123456"
    },
    "approved": "1"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/domain/list/
-d key=KEY
-d secret=SECRET
-d group=1234


# Example successful response

{
    "success": true,
    "groups": {
        "123": {
            "id": "123",
            "domain": "domain.com",
            "flex": {
                "1-abcdefgi01234567": "pub-0123456"
            },
            "approved": "1"
        },
        "124": {
            "id": "124",
            "domain": "example.com",
            "flex": {},
            "approved": "0"
        },
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/domain/invite/
-d key=KEY
-d secret=SECRET
-d group=1234
-d tag=abcdefgi01234567
-d message=Request+from+Ad+Network+as+discussed+with%2C+john%40example.com.


# Example invalid tag response

{
    "success": false,
    "reason": "invalid-tag"
}


# Example successful response

{
    "success": true,
    "invite": {
        "id": "123",
        "domain": "domain.com",
        "flex": {},
        "approved": "0"
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/domain/edit/
-d key=KEY
-d secret=SECRET
-d group=1234
-d domain=123
-d flex-1-abcdefgi01234567=pub-0123456

# Example unsuccessful response

{
    "success": false,
    "reasons": [
        "1-abcdefgi01234567"
    ]
}


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/domain/remove/
-d key=KEY
-d secret=SECRET
-d group=1234
-d domain=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example group request array

{
    "id": "1234",
    "domain": "domain.com",
    "approved": "1",
    "message": "My publisher account username is ABC123."
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/request/list/
-d key=KEY
-d secret=SECRET
-d domain=1234


# Example successful response

{
    "success": true,
    "requests": {
        "123": {
            "id": "123",
            "group": "domain.com",
            "approved": "0",
            "message": "My publisher account username is ABC123."
        },
        "124": {
            "id": "124",
            "group": "example.com",
            "approved": "0",
            "message": ""
        },
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/request/approve/
-d key=KEY
-d secret=SECRET
-d group=1234
-d request=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/request/decline/
-d key=KEY
-d secret=SECRET
-d group=1234
-d request=123


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example group adstxt array

{
    "tag": "abcdefgi01234567",
    "type": "data",
    "name": "google.com",
    "publisher": "pub-0123456",
    "relationship": "DIRECT",
    "certification": "abcdef012345"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/list/
-d key=KEY
-d secret=SECRET
-d group=1234


# Example successful response

{
    "success": true,
    "adstxt": {
        "version": "0.0.1",
        "records": {
            "123": {
                "tag": "abcdefgi01234567",
                "type": "data",
                "name": "google.com",
                "publisher": "pub-0123456",
                "relationship": "DIRECT",
                "certification": "abcdef012345"
            },
            "124": {
                "tag": "abcdefgi01234568",
                "type": "variable",
                "name": "contact",
                "value": "email@domain.com"
            },
            "125": {
                "tag": "abcdefgi01234569",
                "type": "comment",
                "comment": "Example comment."
            }
        }
    }
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/add/
-d key=KEY
-d secret=SECRET
-d group=1234
-d type=data
-d name=google.com
-d publisher=pub-0123456
-d relationship=DIRECT
-d certification=abcdef012345


# Example invalid record response

{
    "success": false,
    "reasons": [
        "name-invalid",
        "publisher-invalid"
    ]
}


# Example successful response

{
    "success": true,
    "id": "123",
    "tag": "abcdefgi01234567"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/edit/
-d key=KEY
-d secret=SECRET
-d group=1234
-d record=123
-d tag=abcdefgi01234567
-d type=data
-d name=google.com
-d publisher=pub-0123456
-d relationship=DIRECT
-d certification=abcdef012345


# Example invalid record response

{
    "success": false,
    "reasons": [
        "name-invalid",
        "publisher-invalid"
    ]
}


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/remove/
-d key=KEY
-d secret=SECRET
-d group=1234
-d record=123
-d tag=abcdefgi01234567


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/import/
-d key=KEY
-d secret=SECRET
-d group=1234
-d import=google.com%2C+pub-0123456%2C+DIRECT%2C+abcdef012345%0A%23+A+Comment%0Acontact%3Demail%40domain.com


# Example successful response

{
    "success": true
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/group/adstxt/download/
-d key=KEY
-d secret=SECRET
-d group=1234


# Example successful response

{
    "success": true,
    "adstxt": "# ATG-ABCDEFGU01234567\n# Version 0.0.1\ngoogle.com, pub-0123456, DIRECT, abcdef012345\ncontact=email@domain.com"
}

$api = atg_api('KEY', 'SECRET');

# Example adstxt validation array

{
    "line": 1,
    "type": "data",
    "duplicate": [
        "4",
        "17"
    ],
    "data": "domaincom  , 1234567, DIREC, abcdefghijk",
    "error": [
        "data-domain-invalid",
        "data-relationship-invalid"
    ],
    "warning": [],
    "notice": [
        "data-domain-whitespace"
    ],
    "valid": "0"
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/validate/adstxt/
-d key=KEY
-d secret=SECRET
-d url=http://domain.com/ads.txt


# Example successful response

{
    "success": true,
    "error_count": 1,
    "warning_count": 0,
    "notice_count": 1,
    "valid_count": 0,
    "adstxt": {
        "1": {
            "line": 1,
            "type": "data",
            "duplicate": [],
            "data": "example.com, abcdefg, DIRECT",
            "error": [],
            "warning": [],
            "notice": [],
            "valid": "1"
        },
        "2": {
            "line": 2,
            "type": "unknown",
            "duplicate": [],
            "data": " test",
            "error": [
                "line-invalid"
            ],
            "warning": [],
            "notice": [
                "line-whitespace"
            ],
            "valid": "0"
        }
    }
}

$api = atg_api('KEY', 'SECRET');

# Example adstxt comparison array

{
    "domain": "example.com",
    "id": "CUSTOM-ID",
    "url": "http://example.com/ads.txt",
    "status": "missing",
    "missing": [
        "domain.com, 123456, DIRECT"
    ],
    "error": "",
    "reason": ""
}

$api = atg_api('KEY', 'SECRET');

# Example request

curl https://adstxt.guru/api/1.0/compare/adstxt/
-d key=KEY
-d secret=SECRET
-d adstxt=domain.com, 12345, DIRECT
-d domains=example.com,EXAMPLE-ID\n
    http://www.missing.com\n
    subdomain.failed.com


# Example successful response

{
    "success": true,
    "matched_count": 1,
    "partial_count": 1,
    "failed_count": 1,
    "results": [
        {
            "domain": "example.com",
            "id": "EXAMPLE-ID",
            "url": "https://example.com/ads.txt",
            "status": "success",
            "missing": [],
            "error": "",
            "reason": ""
        },
        {
            "domain": "http://missing.com",
            "id": "ID",
            "url": "https://www.missing.com/ads.txt",
            "status": "missing",
            "missing": [
                "domain.com, 12345, DIRECT"
            ],
            "error": "",
            "reason": ""

        },
        {
            "domain": "subdomain.failed.com",
            "id": "",
            "url": "https://subdomain.failed.com/ads.txt",
            "status": "failed",
            "missing": [],
            "error": "Connection error",
            "reason": "Your URL returned a 404 File Not Found error indicating an ads.txt file can not be found."
        }
    ]
}

$api = atg_api('KEY', 'SECRET');