@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Domains-Index API
@version 1.0
@auth ApiKey api_key in query
@endpoints 14
@toc domains(9), info(5)

@group domains
@endpoint GET /domains/search
@desc Domains Database Search
@optional {api_key: any # API key, date: any # Request date, page: any # Search page to request, limit: any # Results per page, domain: any # Domain includes, zone: any # In Zone, country: any # Hosting Country, isDead: any # Dead or Not, default not, A: any # A record includes, NS: any # NS record includes, CNAME: any # CNAME record includes, MX: any # MX record includes, TXT: any # TXT record includes}
@returns(200) Success
@errors {403: api_key is not valid, 404: Results not found}

@endpoint GET /domains/tld/{zone_id}
@desc Get TLD records
@optional {api_key: any # API key, date: any # Request date, page: any # Search page to request, limit: any # Results per page, domain: any # Domain includes, country: any # Hosting Country, isDead: any # Dead or Not, default not, A: any # A record includes, NS: any # NS record includes, CNAME: any # CNAME record includes, MX: any # MX record includes, TXT: any # TXT record includes}
@returns(200) Success
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/tld/{zone_id}/download
@desc Download Whole Dataset for TLD
@optional {api_key: any # API key, date: any # Request date}
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/tld/{zone_id}/search
@desc Domains Search for TLD
@optional {api_key: any # API key, date: any # Request date, page: any # Search page to request, limit: any # Results per page, domain: any # Domain includes, country: any # Hosting Country, isDead: any # Dead or Not, default not, A: any # A record includes, NS: any # NS record includes, CNAME: any # CNAME record includes, MX: any # MX record includes, TXT: any # TXT record includes}
@returns(200) Success
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/updates/added
@desc Get added domains, latest if date not specified
@optional {api_key: any # API key, date: any # Request date, page: any # Search page to request, limit: any # Results per page}
@returns(200) Success
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/updates/added/download
@desc Download added domains, latest if date not specified
@optional {api_key: any # API key, date: any # Request date}
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/updates/deleted
@desc Get deleted domains, latest if date not specified
@optional {api_key: any # API key, date: any # Request date, page: any # Search page to request, limit: any # Results per page}
@returns(200) Success
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/updates/deleted/download
@desc Download deleted domains, latest if date not specified
@optional {api_key: any # API key, date: any # Request date}
@errors {403: No api_key or it's not valid, 404: Results not found}

@endpoint GET /domains/updates/list
@desc List of updates
@optional {api_key: any # API key}
@returns(200) Success
@errors {403: No api_key or it's not valid, 404: Results not found}

@endgroup

@group info
@endpoint GET /info/api
@optional {api_key: any # API key}
@returns(200) Success

@endpoint GET /info/stat/
@desc Returns overall stagtistics
@optional {page: any # Search page to request, limit: any # Results per page}
@returns(200) Success

@endpoint GET /info/stat/{zone}
@desc Returns statistics for specific zone
@optional {page: any # Search page to request, limit: any # Results per page}
@returns(200) Success
@errors {404: Zone not found.}

@endpoint GET /info/tld/
@desc Returns overall Tld info
@returns(200) Success

@endpoint GET /info/tld/{zone}
@desc Returns statistics for specific zone
@optional {page: any # Search page to request, limit: any # Results per page}
@returns(200) Success
@errors {404: Zone not found.}

@endgroup

@end