Get industry average ratios

GET /api-v1/ratios/ratios-report

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Query parameters

endDate string Required

endDate
lastYear boolean

lastYear

Default value is false.
lastYearEndDate string

lastYearEndDate
lastYearStartDate string

lastYearStartDate
startDate string Required

startDate

Responses

200

OK
Hide response attributes Show response attributes object
- industryAverage number
- lastYearValue number
- ratioGroup string
  
  Values are LIQUIDITY_RATIOS, PROFITABILITY_RATIOS, DEBT_RATIOS, or EFFICIENCY_RATIOS.
- ratioType string
  
  Values are CASH_RATIO, QUICK_RATIO, CURRENT_RATIO, GROSS_MARGIN, NET_MARGIN, RETURN_ON_ASSETS, RETURN_ON_EQUITY, RETURN_ON_CAPITAL, INTEREST_COVERAGE, DEBT_RATIO, DEBT_TO_EQUITY, CAPITALIZATION_RATIO, ASSET_TURNOVER, or INVENTORY_TURNOVER.
- value number
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/ratios/ratios-report

curl \
 -X GET http://10.10.10.132/api-v1/ratios/ratios-report?endDate=string&startDate=string \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "industryAverage": 42.0,
    "lastYearValue": 42.0,
    "ratioGroup": "LIQUIDITY_RATIOS",
    "ratioType": "CASH_RATIO",
    "value": 42.0
  }
]