Phish.net API v5 Documentation

Table of Contents

• API v5 Docs
  • Methods
  • Request Structure
  • Authentication
  • Additional Parameters
  • Formats
  • Data Storage
  • Attribution
  • Credits
• Example API Calls
• Error Messages
• Callbacks
• Special Methods
• Sample Project @ Github
• Terms of Use

Error Checking

If your request contains an error, you may end up with unexpected output. If your request URI contains a typos, uses improper case, or requests or sorts by a nonexistent column, you may end up with no data in your response.

If you use the HTML format – an error will display "No results found.".

If you use the XML format – you will end up with an empty results node.

The JSON format works a bit differently. Every JSON response is has three return nodes: error, error_message, and data. A successful response will contain error 0, a blank error_message, and a data object populated with your response. An error response will contain an error code number, a text-based error message, and a blank data object.

Possible error codes are:

• 0 => "Success"
• 1 => "General API error"
• 2 => "Invalid API Key"
• 4 => "Rate limit has been reached"
• 7 => "Invalid API Method"
• 8 => "Invalid input data: Parameter(s) missing or out of bounds"
• 10 => "Invalid protocol. API connections must be made over SSL"
• 11 => "No data matched your query"
• 12 => "Access denied"