Industry Market Zip Codes
This section describes US and Local Industry Market zip codes, a parameter for Industry Market Data.
Endpoint
https://api.bizminer.com/v1/bizminer/imr/zips/{state}/{apiKey}/{requestId}/{hash}
Request Type
- get - all requests to this endpoint must be
get
types.
Demo
Parameters
All parameters are required.
stateId (int 2) The areaId of the state of the zips to be returned. API EndpointapiKey (varchar 40) The API key as provided by BizMiner staff. Used for authentication and billing.
requestId (varchar 16) An optional value to track and debug client calls. Default to 0.
hash (varchar 40) The SHA1 hashed value of:stateId + apiKey using the secret provided by BizMiner at the time of providing the API key. This is used to authenticate requests. If the hash does not match server-side validation, and error response will be returned.
Successful Response Data Structure
The following is the data structure of 200 responses. For a list of unsuccessful response codes see here.
-status (HTTP code) -responseID (unique code from the server for debugging) -stateName (the name of the state) -zips [collection] -zip (zip code) ...