Vestimate-Pro Business Value Analysis
This section describes access to BizMiner's Vestimate-Pro Business Value Analysis.
Endpoint
https://api.bizminer.com/v1/bizminer/vestimateprodata/{bznaics}/{areaId}/{zips}/{mapCenter}/{mapCenterZip}/{radius}/{saleClassId}/{apiKey}/{requestId}/{hash}
Request Type
- post - all requests to this endpoint must be
posttypes.
Demo
Get Parameters
All parameters are required. For market area, there are three options:
bznaics (decimal 12,6) The BizMiner industry code. API EndpointareaId (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
All parameters are required.
inputData (text) Firm input data. It must follow the format below. At least one year of data must have a value for revenue and one of officersCompensation, depreciation, or preTaxNetProfit.The inputData should be in json format:
{ "[year]": { "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]" }, "[year]": { "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]" }, "[year]": { "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:
{ "2019": { "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" }, "2018": { "revenue":"1,749,451", "grossMargin":"742,379", "officersCompensation":"116,091", "depreciation":"20,652", "operatingExpenses":"638,951", "interestExpense":"7,401", "preTaxNetProfit":"101,442", "ownerReplacementCompensation":"20,324", "incomeExpenseAddbacks":"12,459", "accountsReceivable":"125,244", "currentAssets":"282,766", "totalAssets":"444,036", "accountsPayable":"69,943", "currentLiabilties":"151,828", "longTermLiabilities":"93,491", "fullTimeEmployees":"10", "avgAnnualWage":"53,654" }, "2017": { "revenue":"1,736,918", "grossMargin":"720,774", "officersCompensation":"110,225", "depreciation":"19,760", "operatingExpenses":"609,759", "interestExpense":"7,055", "preTaxNetProfit":"109,441", "ownerReplacementCompensation":"22,324", "incomeExpenseAddbacks":"0", "accountsReceivable":"101,697", "currentAssets":"230,479", "totalAssets":"355,407", "accountsPayable":"57,646", "currentLiabilties":"124,685", "longTermLiabilities":"76,479", "fullTimeEmployees":"10", "avgAnnualWage":"52,536" } }
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)
-timeSeries (report data time series)
-bznaics (report bznaics code)
-industry (report industry name)
-saleClass (report industry name)
-saleClass (report sales class)
-area (report area title)
-reportData [collection]
-industryMarket [collection]
-totalPopulation
-totalHouseholds
-medianAge
-populationMillennials
-populationGenX
-populationBoomers
-educationBachelorsDegree
-educationAssociatesDegree
-housingMedianValue
-housingMedianRent
-incomePerCapita
-incomeMean
-incomeMedian
-incomeHouseholdsOver100k
-operations
-firms
-branches
-smallBusinesses
-employment
-employmentSmallBusiness
-averageEmployment
-marketVolume
-marketVolumeSmallBusiness
-averageSiteSales
-medianSiteSales
-averageSmallBusinessSales
-averageSiteSalesChange
-averageSmallBusinessSalesChange
-firmSalesRank
-firmSalesRankPercentile
-firmMarketShare
-USSalesPerPerson
-USSalesPerHousehold
-marketSalesPerPerson
-marketSalesPerHousehold
-startups
-marketIndustryStartupRate
-USIndustryStartupRate
-marketCessationRate
-USCessationRate
-industryMarketGrowthUS
-industryMarketGrowthLocal
-smallBusinessMarketShareYear1
-smallBusinessMarketShareYear3
-years [collection]
-year1 [collection]
-year
-salesPerEmployee
-averageAnnualWage
-industryPeerGroupFirmsAnalyzed
-industryMarketAverageSiteSales
-industryMarketGrossVolume
-marketSalesHousehold
-USSalesHousehold
-marketOpportunityIndex
-year2 [collection]
-year
-salesPerEmployee
-averageAnnualWage
-industryPeerGroupFirmsAnalyzed
-industryMarketAverageSiteSales
-industryMarketGrossVolume
-marketSalesHousehold
-USSalesHousehold
-marketOpportunityIndex
-year3 [collection]
-year
-salesPerEmployee
-averageAnnualWage
-industryPeerGroupFirmsAnalyzed
-industryMarketAverageSiteSales
-industryMarketGrossVolume
-marketSalesHousehold
-USSalesHousehold
-marketOpportunityIndex
-industryFinancial [collection]
-bznaics
-industry
-years [collection]
-year1 [collection]
-year
-profitLoss [collection]
-dollars [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-dollarsFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentages [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentagesFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-variance [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-ownerEarnings
-balanceSheet [collection]
-dollars [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-dollarsFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentages [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentagesFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-variance [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-ratios [collection]
-industry [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-firm [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-variance [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-scores [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-year2 [collection]
-year
-profitLoss [collection]
-dollars [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-dollarsFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentages [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentagesFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-variance [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-ownerEarnings
-balanceSheet [collection]
-dollars [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-dollarsFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentages [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentagesFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-variance [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-ratios [collection]
-industry [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-firm [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-variance [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-scores [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-year3 [collection]
-year
-profitLoss [collection]
-dollars [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-dollarsFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentages [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-percentagesFirm [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-expenseAddbacks
-ownerReplacementCompensation
-ownerEarnings
-variance [collection]
-revenue
-officerCompensation
-depreciation
-operatingIncome
-interestExpense
-preTaxNetProfit
-ownerEarnings
-balanceSheet [collection]
-dollars [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-dollarsFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentages [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-percentagesFirm [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-variance [collection]
-accountsReceivable
-totalCurrentAssets
-totalAssets
-accountPayable
-currentLiabilities
-totalLiabilities
-netWorth
-ratios [collection]
-industry [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-firm [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-variance [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-scores [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-KPIs [collection]
-currentRatio
-daysPayable
-ownerEarnings
-returnOnAssets
-daysReceivable
-efficiencyIndex
-modifiedZScore
-interestCoverage
-totalLiabilitiestoNetWorth
-growthMetrics [collection]
-industry [collection]
-discretionaryOwnerEarningsGrowth
-salesGrowth
-firm [collection]
-discretionaryOwnerEarningsGrowth
-salesGrowth
-variance [collection]
-discretionaryOwnerEarningsGrowth
-salesGrowth
-vestimate
-assetSaleValueEarningsApproach
-assetSaleValueIncomeApproach
-equitySaleValueEarningsApproach
-equitySaleValueIncomeApproach
-years [collection]
-year1 [collection]
-year
-assetSaleValueEarningsApproach
-assetSaleValueIncomeApproach
-year2 [collection]
-year
-assetSaleValueEarningsApproach
-assetSaleValueIncomeApproach
-year3 [collection]
-year
-assetSaleValueEarningsApproach
-assetSaleValueIncomeApproach