Hyperz Documentation > Knowledgebase > Other > KoroxCAD API

KoroxCAD API

Hyperz

Table of Contents


Plate Runner

code example

const axios = require('axios');
runPlate()

async function runPlate() {
    let data = {
        "community": 'YOUR_COMMUNITY_ID_GOES_HERE',
        "plate": 'THE_PLATE_TO_CHECK_GOES_HERE',
        "apisecret": 'YOUR_API_SECRET_GOES_HERE'
    };
    let results = await axios.post("https://koroxcad.com/api/1.1/wf/platerunner", data);
    console.log(results.data.response)
};

what gets returned:

{
  "plate": "22REH726",
  "owner": "chuck livingston",
  "insurance": "Valid",
  "stolen": false,
  "model": "M.O.C",
  "color": "Black"
}

Name Runner

code example

const axios = require('axios');
runName()

async function runName() {
    let data = {
        "community": 'YOUR_COMMUNITY_ID_GOES_HERE',
        "name": 'THE_NAME_TO_CHECK_GOES_HERE',
        "apisecret": 'YOUR_API_SECRET_GOES_HERE'
    };
    let results = await axios.post("https://koroxcad.com/api/1.1/wf/namerunner", data);
    console.log(results.data.response)
};

what gets returned:

{
    "name": "JOHN DOE",
    "dob": "1/01/95",
    "address": "1234 Playground Street",
    "mugshot": "//s3.amazonaws.com/appforest_uf/f1654968512196x834524504570466200/noimage.png",
    "gender": "Male",
    "race": "White",
    "height": "6'1",
    "weight": "145",
    "driversLicenseStatus": "Valid",
    "hairColor": "Black",
    "vehicles": [
        {
            "Color": "Gray",
            "Community": "CENSORED",
            "InsuranceStatus": "Valid",
            "Model": "Chevy Silverado",
            "Plate": "ABCDEF",
            "R.O.": "CENSORED",
            "stolen?": false,
            "Created By": "CENSORED",
            "Created Date": 1654630999703,
            "Modified Date": 1654963038485,
            "communityId": "CENSORED",
            "_id": "CENSORED"
        }
    ],
    "firearms": [
        {
            "Color": "Black",
            "Community": "CENSORED",
            "isStolen": false,
            "Model": "Heavy Revolver",
            "Owner": "CENSORED",
            "Registration Number": "01436866",
            "REVOKED": false,
            "Created By": "CENSORED",
            "Created Date": 1654631016244,
            "Modified Date": 1654631019743,
            "_id": "CENSORED"
        }
    ]
}

Livemap

code example

const axios = require('axios');
updateLocation()

async function updateLocation() {
    let body = {
       community: "YOUR_COMMUNITY_ID",
       apisecret: "YOUR_API_SECRET",
       steamhex: "ACCOUNT_STEAM_HEX",
       street: "STREET_NAME",
       crossstreet: "CROSS_STREET_NAME",
       postal: "NEAREST_POSTAL_CODE",
    };
    let results = await axios.post("https://koroxcad.com/api/1.1/wf/livemap", data);
    console.log(results.data.response)
};

what gets returned:

200

Scripts to use:


Was this article helpful?

35 out of 67 found this helpful