alt text Industry Market Area Codes

This section describes US and Local Industry Market areas, a required parameter for Industry Market Data.

Endpoint

https://api.bizminer.com/v1/bizminer/imr/areas/{areaType}/{apiKey}/{requestId}/{hash}

Request Type

Demo

https://api.bizminer.com/v1/bizminer/imr/areas/metros/77DE68DAECD823BABBB58EDB1C8E14D7106E83BB/1/4e8abad3822ac2d58c874d04913f2ed5ab7b680e

Parameters

All parameters are required. 

areaType (varchar 10)
The type of area, which must be one of:
    -US
    -states
    -metros
    -counties


apiKey (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:areaType + 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)
 -areas [collection] 
    -areaId (code to use with Industry Finanical Data)
    -areaName (area name)
    ...