Parameters

This is a full list of the NPS API parameters the API expects.

cmd={COMMAND}

The cmd parameter needs to be assigned a {COMMAND} ie. cmd=nps. Valid commands are:

Command Description Example Require valid token

add Add a suspicious vehicle number plate to NPS.
Pass the numberplate to parameter np and the reason for the lookout to paremeter str
. ie : np=ABC123GP&str=Suspicious vehicle in the Honeydew area. {
...
result:"true"
desc:"Number plate <{NP}>added to the system as a lookout"
...
} Yes

demo Demo command to test your application with. {
...
result:"true"
desc:"Hello World!"
...
} No

mute Mute the specific number plate passed in parameter np results for the token user. {
...
result:"true"
desc:"Number plate <{NP}> MUTED for token <{TOKEN}>."
...
} Yes

ping Ping command to test communication the API will return Pong. {
...
result:"true"
desc:"Pong"
...
} No

stats Stats command to check the capture stats on the capture bots.. {
...
result:"true"
desc:"Facebook
Group Monitored : 518
Captured : 1419405
Twitter
Following : 367
Tweets captured : 243054
NP Tracker
Numberplates captured : 15305"
...
} Yes

unmute UN-mute the specific number plate passed in parameter np results for the token user. {
...
result:"true"
desc:"Number plate <{NP}> UN-MUTED for token <{TOKEN}>."
...
} Yes

nps Do a NPS lookup with the number plate passed to parameter np. {
...
result:"true"
desc:"The results of your query"
...
} Yes

Command	Description	Example	Require valid token
add	Add a suspicious vehicle number plate to NPS. Pass the numberplate to parameter np and the reason for the lookout to paremeter str . ie : np=ABC123GP&str=Suspicious vehicle in the Honeydew area.	{ ... result:"true" desc:"Number plate <{NP}>added to the system as a lookout" ... }	Yes
demo	Demo command to test your application with.	{ ... result:"true" desc:"Hello World!" ... }	No
mute	Mute the specific number plate passed in parameter np results for the token user.	{ ... result:"true" desc:"Number plate <{NP}> MUTED for token <{TOKEN}>." ... }	Yes
ping	Ping command to test communication the API will return Pong.	{ ... result:"true" desc:"Pong" ... }	No
stats	Stats command to check the capture stats on the capture bots..	{ ... result:"true" desc:"Facebook Group Monitored : 518 Captured : 1419405 Twitter Following : 367 Tweets captured : 243054 NP Tracker Numberplates captured : 15305" ... }	Yes
unmute	UN-mute the specific number plate passed in parameter np results for the token user.	{ ... result:"true" desc:"Number plate <{NP}> UN-MUTED for token <{TOKEN}>." ... }	Yes
nps	Do a NPS lookup with the number plate passed to parameter np.	{ ... result:"true" desc:"The results of your query" ... }	Yes

All results are returned in JSON format.

np={NUMBERPLATE}

The np parameter needs to be assigned a {NUMBERPLATE} ie. np=ABC123GP

Command {NUMBERPLATE} expected

add
mute
nps Number plate to test OR add.

Command	{NUMBERPLATE} expected
add mute nps	Number plate to test OR add.

str={STRING}

The str parameter needs to be assigned a {STRING} ie. str=Suspicious vehicle in the Honeydew area.

Command {STRING} expected

add Reason to add number plate as a lookout.

nps Number plate to test.

Command	{STRING} expected
add	Reason to add number plate as a lookout.
nps	Number plate to test.

tkn={TOKEN}

The tkn parameter needs to be assigned a valid {TOKEN} ie. tkn=AABBCCDDEEFFGGHHII and can be obtained here

id={ID}

The id parameter can be assigned a UNSIGNED INTEGER to identify and sync results from the API to your app. Each JSON result will contain the {ID} of the request sent to the API.

trim={LENGTH}

Trim the output to max characters length given by {LENGTH}.

history={MONTHS}

Only return results last updated in {MONTHS}.

NP Tracker API