Real-time product request
Last updated
Last updated
To make a simple request for a single market page, use the /realtime/ecommerce
endpoint with the following syntax:
Every request sent through Nimble API is automatically routed through Nimble IP - our premium proxy network!
vendor
Required
String walmart, amazon
url
Required
Enum: URL
country
Optional (default = all)
state
Optional
For targeting US states (does not include regions or territories in other countries). Two-letter state code, e.g. NY, IL, etc.
city
Optional
zip
optional
String A 5-digit US zip code. If provided, the closest store to the provided zip code is selected.
locale
Optional (default = en)
String | LCID standard locale used for the URL request. Alternatively, user can use auto
for automatic locale based on country targeting.
parse
Optional (default = false)
Enum: true | false Instructs Nimble whether to structure the results into a JSON format or return the raw HTML.
Walmart Options
store
optional
String
If not provided, the closest store to the provided zip code is selected.
Headers
X-Task-ID: string
Payload examples:
If parsing was disabled or omitted in the request, the result data will be the raw HTML of the requested page. If parsing was enabled, a JSON object with a parsed version of the page will be delivered, with the raw HTML included under the html_content
property.
200 OK
500 Error
400 Input Error
200
OK
400
The requested resource could not be reached
401
Unauthorized/invalid credental string
500
Internal service error
501
An error was encountered by the proxy service
String Country used to access the target URL, use i.e. US, DE, GB
For targeting large cities and metro areas around the globe. When targeting major US cities, you must include state as well.