AWZ · API reference

Before you call anything

1. Turn on Enable HTTP script commands in AWZ Settings → Scripts.
2. AWZ must be in the foreground before every command:

runApp("AWZ")
mSleep(3 * 1000)  -- First launch verifies the license online; waiting 3 seconds is safe

Return values

The call returns JSON directly:

{"result": 1}

The same value is written to /var/mobile/iggresult.txt, and both always agree:

Endpoint list

Endpoint details

All addresses below use the on-device 127.0.0.1. From a computer, substitute the device's LAN IP.

Reset

GET http://127.0.0.1:1688/cmd?fun=newrecord

Generates a new device and creates a record. A return value of 3 means the reset worked but the IP duplicates an existing record — your script can decide whether to rotate the IP and retry.

Next record

GET http://127.0.0.1:1688/cmd?fun=nextrecord

Switches to the next record. A return value of 4 means you are already on the last one.

Activate a specific record

GET http://127.0.0.1:1688/cmd?fun=activerecord&record=record-id

Activate the first / last record

GET http://127.0.0.1:1688/cmd?fun=activefirstrecord
GET http://127.0.0.1:1688/cmd?fun=activelastrecord

Disable / re-enable a record

GET http://127.0.0.1:1688/cmd?fun=disablerecord&record=record-id
GET http://127.0.0.1:1688/cmd?fun=enablerecord&record=record-id

Delete a specific record

GET http://127.0.0.1:1688/cmd?fun=deleterecord&record=record-id

Clear every record

GET http://127.0.0.1:1688/cmd?fun=deleteallrecords

Wipes every record. This cannot be undone.

Slim a specific record

GET http://127.0.0.1:1688/cmd?fun=thinrecord&record=record-id

Trims the given record to reduce the disk space it uses.

Export a specific record

GET http://127.0.0.1:1688/cmd?fun=exportrecord&record=record-id

Exports to /var/mobile/exportdata/.

Export every record

GET http://127.0.0.1:1688/cmd?fun=exportallrecords&zip=file-name

Exports to /var/mobile/exportdata/.

Import a record directly

GET http://127.0.0.1:1688/cmd?fun=importdirect

Put the record to import in /var/mobile/importdata/ — either an exported folder or an exported zip.

Import a record in compatibility mode

GET http://127.0.0.1:1688/cmd?fun=importcompatible

Imports from /var/mobile/importdata/ in compatibility mode, accepting either a folder or a zip. Try this when a direct import fails.

Import an NZT record

GET http://127.0.0.1:1688/cmd?fun=importnzt

Put the NZT record in /var/mobile/nztdata/. It must be an unpacked folder or an unencrypted zip.

Rename the current record

GET http://127.0.0.1:1688/cmd?fun=renamecurrentrecord&name=new-name

Set / clear the current record's coordinates

GET http://127.0.0.1:1688/cmd?fun=setcurrentrecordlocation&location=longitude_latitude_place
GET http://127.0.0.1:1688/cmd?fun=clearcurrentrecordlocation

Get / set the current record's parameters

GET http://127.0.0.1:1688/cmd?fun=getcurrentrecordparam
GET http://127.0.0.1:1688/cmd?fun=setcurrentrecordparam

• getcurrentrecordparam: writes the current record's parameters to /var/mobile/iggparams.txt
• setcurrentrecordparam: reads /var/mobile/iggparams.txt and applies those parameters to the current record

Correct flow: get first, edit the fields in the file, then set. See Parameter file for the format.

Get every record name

GET http://127.0.0.1:1688/cmd?fun=getallrecordnames

The list of names is written to /var/mobile/iggrecords.txt.

Clean App Store data

GET http://127.0.0.1:1688/cmd?fun=cleanappstore

If "Clean App Store" is already enabled in the app settings, a reset runs it automatically and you do not need to call this.

Uninstall the selected apps

GET http://127.0.0.1:1688/cmd?fun=uninstallselectedapp

If "Uninstall apps" is already enabled in the app settings, a reset runs it automatically and you do not need to call this.

Sort by time

GET http://127.0.0.1:1688/cmd?fun=orderbytime
GET http://127.0.0.1:1688/cmd?fun=orderbytimedesc

orderbytime sorts the record list oldest first; orderbytimedesc sorts it newest first.

Parameter file

Path: /var/mobile/iggparams.txt

• One parameter per line, separated by chr(10)
• The name and value are separated by a colon :
• Call getcurrentrecordparam and open the file to see the exact format

Lua example (TouchSprite)

local sz = require("sz")
local http = require("szocket.http")

local BASE = "http://127.0.0.1:1688/cmd?fun="

-- URL encoding (needed for non-ASCII names and place names)
function urlEncode(s)
    s = string.gsub(s, "([^%w%.%- ])", function(c)
        return string.format("%%%02X", string.byte(c))
    end)
    return string.gsub(s, " ", "+")
end

-- Call a command and return its result; a value of 2 means running, so it waits
function AWZ(query)
    local res, code = http.request(BASE .. query)
    if code ~= 200 then return nil end
    local result = sz.json.decode(res).result
    while result == 2 do
        mSleep(1000)
        result = tonumber(readFileString("/var/mobile/iggresult.txt"))
    end
    return result
end

-- 1. Launch AWZ (required before any command)
runApp("AWZ")
mSleep(3 * 1000)

-- 2. Reset, retrying when the IP is a duplicate
local r = AWZ("newrecord")
if r == 3 then
    toast("IP is a duplicate, rotate your IP and retry", 2)
elseif r == 100 then
    toast("Not activated, or the license expired", 2)
elseif r ~= 1 then
    toast("Reset failed: " .. tostring(r), 2)
end

-- 3. Rename the current record (new-name becomes the record ID)
AWZ("renamecurrentrecord&name=" .. urlEncode("139xxxxxxx John"))

-- 4. Set the coordinates
AWZ("setcurrentrecordlocation&location=" .. urlEncode("116.7361382365_39.8887921413_Beijing"))

-- 5. Activate a specific record
AWZ("activerecord&record=" .. urlEncode("Wechat001"))

-- 6. Walk every record
AWZ("activefirstrecord")
while true do
    -- ... your own logic here ...
    if AWZ("nextrecord") == 4 then break end
end

For usage, see the AWZ user guide.