API Reference
Control your proxies via API
Retrieves the Illusory product stock.
cURL
curl --request GET \ --url https://cmd.illusory.io/v1/stock \ --header 'Authorization: Bearer <token>'
{ "ok": true, "message": "Retrieved stock successfully.", "data": [ { "city": "Austin", "state": "TX", "att": 0, "verizon": 39, "tmobile": 0, "status": "available", "open": true, "visible": true }, { "city": "Cleveland", "state": "OH", "att": 0, "verizon": 1, "tmobile": 0, "status": "available", "open": true, "visible": true }, { "city": "Los Angeles", "state": "CA", "att": 0, "verizon": 0, "tmobile": 0, "status": "out", "open": true, "visible": true }, { "city": "New York", "state": "NY", "att": 0, "verizon": 0, "tmobile": 0, "status": "coming", "open": false, "visible": true } ] }
The Authorization header is used to authenticate with the API using your Master API key. Value is of the format Bearer YOUR_KEY_HERE.
Authorization
Master
Bearer YOUR_KEY_HERE
Server response
Indicates whether the request was successful e.g., true
true
Success message
"Retrieved stock successfully."
An array of stock details
Show child attributes
The city where the server is located
"Austin"
The abbreviated state where the server is located. e.g., TX
TX
"TX"
Amount of AT&T stock available
10
Amount of Verizon stock available
Amount of T-Mobile stock available
Current status of the stock, e.g., available, out, coming_soon
available
out
coming_soon
"available"
Indicates whether the stock is open for purchase
Indicates whether the stock is visible on the website
Was this page helpful?