API Guide

Get SNDS Sample

Retrieves sample data associated with a given SNDS ID, IPv4 address, and date. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:


Sample Output:

        "sample_id"       : "8",
        "helo"            : "foo.bar.baz",
        "mailfrom"        : "foo@bar.com",
        "fromdomain"      : "bar.com",
        "samplecomplaint" : <contents of sample>


Parameter Description Acceptable Values Required
id SNDS registration ID. Integer Y
report_id ID from the SNDS Report Integer Y

Error Responses

Description Code Cause
You must provide a numeric SNDS ID. 400 The SNDS key was missing or not an integer value.
You must provide a valid IPv4 address. 400 The IP address must be specified in dotted-quad format, and only IPv4 addresses are supported.
You must provide a date in the format Y-m-d. 400 You supplied a startdate but it was in the wrong format.
Bad or missing API key. 401 The X-API-KEY header was missing or contained an unrecognized/invalid key.
No results found. 404 The report parameters were correct but no results were returned.