SWOT-XPRESS Data

This section describes data access for BizMiner's SWOT-XPRESS reports.

Endpoint

https://api.bizminer.com/v1/bizminer/swot-xpressdata/{bznaics}/{areaId}/{zips}/{mapCenter}/{mapCenterZip}/{radius}/{saleClassId}/{apiKey}/{requestId}/{hash}

Request Type

• get - for requests without inputs
• post - for requests with inputs

Demo - Get

A get demo with no inputs:

https://api.bizminer.com/v1/bizminer/swot-xpressdata/238220/13820/0/0/0/0/5/77DE68DAECD823BABBB58EDB1C8E14D7106E83BB/9999/9bdabd4b9f7184fd2829f8bcb9bc7951e8b57468

Demo - Post

A postdemo with inputs:

Get Parameters

All parameters are required.

bznaics (decimal 12,6)
The BizMiner industry code. API Endpoint

areaId (int 10)
The area id, US, state, metro, or county. API Endpoint
zips (varchar 255)
One or more zip code, separated by commas. API Endpoint
mapCenter (varchar 255)
A US address for the center of a radius area. 
mapCenterZip (varchar 255)
The zip code for the center of a radius area. 
radius (int 3)
The radius in miles of the market area. 
saleClassId (int 2)
The sales class. API Endpoint
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: bznaics + areaId + zips + mapCenter + mapCenterZip + radius + saleClassId + 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. 

Post Parameters

Parameters are optional.

inputData (text)
Firm input data. It must follow the format below.

The inputData should be in json format:
{
    revenue: "[value]"
    grossMargin: "[value]"
    officersCompensation: "[value]"
    depreciation: "[value]"
    operatingExpenses: "[value]"
    interestExpense: "[value]"
    preTaxNetProfit: "[value]"
    ownerReplacementCompensation: "[value]"
    incomeExpenseAddbacks: "[value]"
    accountsReceivable: "[value]"
    currentAssets: "[value]"
    totalAssets: "[value]"
    accountsPayable: "[value]"
    currentLiabilties: "[value]"
    longTermLiabilities: "[value]"
    fullTimeEmployees: "[value]"
    avgAnnualWage: "[value]"
}
The following is an example:
{
    "revenue":"1,612,441",
    "grossMargin":"684,190",
    "officersCompensation":"98,334",
    "depreciation":"24,189",
    "operatingExpenses":"582,379",
    "interestExpense":"6,902",
    "preTaxNetProfit":"104,430",
    "ownerReplacementCompensation":"30,324",
    "incomeExpenseAddbacks":"15,459",
    "accountsReceivable":"96,277",
    "currentAssets":"216,496",
    "totalAssets":"343,598",
    "accountsPayable":"55,898",
    "currentLiabilties":"118,480",
    "longTermLiabilities":"76,001",
    "fullTimeEmployees":"10",
    "avgAnnualWage":"55,489"
}

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)
 -reportMeta [collection] (report parameters)
    -reportType (report title)
    -industryFinancial [collection]
        -timeSeries (report data time series)
        -bznaics (report bznaics code)
        -industry (report industry name)
        -saleClass (report sales class)
    -industryMarket [collection]
        -timeSeries (report data time series)
        -bznaics (report bznaics code)
        -industry (report industry name)
        -marketArea (report area title)
 -reportData [collection]
    -industryMarket [collection]
        -competitors
        -industryMarketSalesVolume
        -averageSiteSales
        -averageSmallBusinessSales
        -firmSalesRank
        -marketSalesPerHousehold
        -USSalesPerHousehold
        -marketSalesPerPerson
        -USSalesPerPerson
        -perCapitaIncome
        -medianHouseholdIncome
        -totalPopulation
        -totalHouseholds
        -locationQuotient
    -industryFinancial [collection]
        -grossMarginPercent
        -grossMarginDollar
        -officerOwnerCompensationPercent
        -officerOwnerCompensationDollar
        -depreciationPercent
        -depreciationDollar
        -operatingExpensesPercent
        -operatingExpensesDollar
        -operatingIncomePercent
        -operatingIncomeDollar
        -afterTaxNetProfitPercent
        -afterTaxNetProfitDollar
        -ownerEarningsPercent
        -ownerEarningsDollar
        -netWorthAssetsPercent
        -netWorthAssetsDollar
        -accountReceivableTotalAssetsPercent
        -accountReceivableTotalAssetsDollar
        -accountPayableTLNWPercent
        -accountPayableTLNWDollar
        -accountPayableTLNWDollar
        -daysReceivable
        -currentRatio
        -interestCoverage
        -currentLiabilitiesNetWorth
        -totalLiabilitiesNetWorth
        -modifiedZScore
        -netWorkingCapitalRevenue
        -accountsPayableRevenue
        -loansNotesPayableNetWorth
    -vestimate [colletion]
        -customVestimate
    -SWOT [colletion]
        -ownerEarnings
        -ownerEarningsPercent
        -peerGroupOwnerEarnings
        -firmOwnerEarnings
        -ownerEarningsVariance
        -averageSaleVariance
        -averageSmallBusinessVariance
        -medianSaleVariance
        -salesPerEmployee
        -salesPerEmployeeVariance
        -ownerEarningsPerEmployee
        -efficiencyIndex
        -efficiencyIndexVariance
        -modifiedZScore
        -modifiedZScoreVariance
        -accountsPayableToRevenue
        -grossMarginPercent
        -officerOwnerCompensationPercent
        -depreciationPercent
        -operatingExpensesPercent
        -afterTaxNetProfitPercent
        -loansNotesPayablePercent
        -salesRankPercentile
        -salesPerPersonIndex
        -salesPerPersonDollar
        -salesPerHouseholdIndex
        -salesPerHouseholdDollar
        -salePerPersonVariance
        -salePerHouseholdVariance
        -locationQuotient
    -scores [colletion]
        -ownerEarnings
        -salesRank
        -varianceFromAverageSales
        -varianceFromSmallBusinessSales
        -salesPerHouseholdMarketOpportunityIndex
        -locationQuotient
        -salesPerEmployeeIndex
        -efficiencyIndex
        -daysReceivable
        -currentRatio
        -currentLiabilitiesToNetWorth
        -longTermLiabilitiesToNetWorth
        -totalLiabilitiesToNetWorth
        -daysPayable
        -modifiedZScore
        -averageScore