Phish.net API v5 Documentation
Table of Contents
- API v5 Docs
- Example API Calls
- Error Messages
- Callbacks
- Special Methods
- Sample Project @ Github
- Terms of Use
Special Methods
Unlike normal methods, special methods require you to specify a subset of data. For some methods, returning every matching record would be a significant strain on the system and would return a result set larger than most apps would need. As a result, special methods require you to be more specific by including arguments to filter the result set.
Special methods cannot be requested naked. Requested to the general endpoint will return an error.
The attendance Method
The attendance method requires you to specify a column for return values. The accepted columns are uid, showid, username, or showdate.
Requests cannot be made like so:
- https://api.phish.net/v5/attendance.json?apikey=_YOUR_APIKEY
Instead, you must craft it like so:
If you do not send additional parameters to narrow in on a smaller data set, you will receive error 12.
The reviews Method
The reviews method requires you to specify a column for return values. The accepted columns are uid, showid, username, or showdate.
Requests cannot be made like so:
- https://api.phish.net/v5/reviews.json?apikey=_YOUR_APIKEY
Instead, you must craft it like so:
If you do not send additional parameters to narrow in on a smaller data set, you will receive error 12.
The users Method
The users method requires you to specify a column for return values. The accepted columns are uid and username.
Requests cannot be made like so:
- https://api.phish.net/v5/users.json?apikey=_YOUR_APIKEY
Instead, you must craft it like so:
If you do not send additional parameters to narrow in on a smaller data set, you will receive error 12.