Platform
Get Stock
Platform
Get Stock
Retrieves the Illusory product stock.
GET
/
v1
/
stock
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
}
]
}
Authorizations
The Authorization
header is used to authenticate with the API using your Master
API key. Value is of the format Bearer YOUR_KEY_HERE
.
Response
200
application/json
Server response
Indicates whether the request was successful e.g., true
Success message
An array of stock details
The city where the server is located
The abbreviated state where the server is located. e.g., TX
Amount of AT&T stock available
Amount of Verizon stock available
Amount of T-Mobile stock available
Current status of the stock, e.g., available
, out
, coming_soon
Indicates whether the stock is open for purchase
Indicates whether the stock is visible on the website
Was this page helpful?
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
}
]
}