Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
JioMart API Capability

Home listing

Read the location-sensitive JioMart home product feed with cursor continuation.

Capability ID jiomart.home.listing
Maximum runtime 30 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

pincode must be a valid six-digit Indian PIN when supplied. page_size must be positive. Follow the returned page_id for continuation.

sort_on is passed through to JioMart and does not create a guaranteed globally sorted feed.

page_id string optional

Page identifier.

page_size integer optional

Number of results per page. At least 1.

Example 10
pincode string optional

Postal code (PIN) that sets the delivery location.

Example 400001
sort_on string optional

Passed unchanged to JioMart; results preserve JioMart's own order. price_asc is not guaranteed to be strictly ascending. No local page sorting.

Response

Successful output is returned in results[0].data.

The home response can include product records, page metadata and the upstream sort choice. Treat it as a location-sensitive feed observation, not a complete local catalogue.

Follow page.next_id with the same PIN, page size and sort context. price_asc is not guaranteed to be strictly ascending.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
items array 3 items
items array 3 items
page object 5 fields
page.has_next boolean true
page.has_previous boolean false
page.item_total integer 2392812
page.next_id string [redacted:token]
page.type string cursor
raw object 3 fields
raw.items array 3 items
raw.page object 5 fields
raw.sort_on string score desc, random_706a230e619d45fdab7e5891a9f98d59 asc

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Overview, pricing and sample data for every endpoint: JioMart API