Standard Response Blocks

success

If 1 is returned, the passed URI query is valid, and the database has been successfully queried. If 0 is returned, more information on the reason why the request failed will be included in a separate error block.

   [success] => 1

error

Below are the common errors returned by Interstat when the system responds with 0 in the success block.

NO_ENDPOINT	A valid endpoint has not been specified. Please refer to the list of endpoints for guidance.
NO_MATCH	A submitted team/league code, or player/game ID, did not match any existing data. You can use the data lookup tools to locate codes, or the meta endpoint to find valid ID numbers.
NO_DATA	There is nothing that matches the query.
SCOPE_MISSING	The query is missing a valid scope parameter.
UNDER_MAINTENANCE	The API is undergoing maintenance or temporary downtime. In the case of scheduled maintenance, the meta block may include details on when the service will be active again.
NO_ACCESS	The IP address is not authorized for use. If you have a valid subscription, you may authorize the IP (returned in the error block) via your account portal.
SUBSCRIPTION_EXPIRED	The annual Interstat subscription has expired.
BLOCKED	Interstat access has been temporarily suspended or permanently revoked due to improperly written code that affects other customers' use of the API in any way, or construction of an identical app or website that utilizes a high percentage of National Statistical's data. Please review our three-strike policy on API abuse.

	[error] => SimpleXMLElement Object
 (
	   [message] => NO_MATCH
	   [detail] => Could not find a team or league with this code.
 )

query

This block contains a breakdown summary of the API call, including any default values added to the query during processing.

[query] => SimpleXMLElement Object
	 (
		   [uri] => https://interst.at/team/cfb/lsu
		   [endpoint] => team
		   [scope] => CFB
		   [range] => lsu
		   [context] => SimpleXMLElement Object
		     	(
		       		[season] => SimpleXMLElement Object
		        			(
		           				[0] => 2022
		        			) 
		     	) 
	 )

meta

The final response block of a data payload contains information about the user account, query status, and current API version.

   [meta] => SimpleXMLElement Object
	    (
		   [user] => National Statistical
		   [access_expires] => 9999-99-99 00:00:00
		   [processed_at] => 9999-99-99 00:00:00
		   [processing_time] => 0.20817303657532 sec
		   [timezone] => America/New_York
		   [ip] => 0.0.0.0
		   [queryid] => is.0000000
		   [api] => Interstat
		   [version] => A.2306
		   [documentation] => https://interst.at
		   [support] => https://natstat.com/support
		   [note] => All times Eastern.
	 )