In addition to viewing Urbics reports in a browser and downloading them as spreadsheet, text, PDF or JSON files, reports are also available in JSON or XML formats through API (Application Programming Interface) calls.
An API call allows for direct access to Urbics data by an application. An API call to retrieve the "Total Valuation By Roll Type" report in json format would look like this:
https://beta.urbics.com/api/reports/av-totals/json
To get an XML response, substitute 'xml' for 'json'.
The header must include your API token - the one you created on the Settings -> API page and saved somewhere safe. That token must have the "Report Access via API" ability, set when the token was created. The token is included in the Authorization header as a Bearer token. The request header must also contain Accept:application/json.
If the json request was successful, a data structure will be returned looking something like this:
{
"data": [
{
"roll_type": "Secured",
"land_value": 127046605,
"impr_value": 444878182,
"pers_value": 3606776,
"exempt_value": 22819447,
"net_value": 552712116,
"detail_link": "https://beta.urbics.com/api/reports/largest-by-roll-type/json?filter%5Broll%5D=sec&filter%5Byear%5D=2020"
},
{
"roll_type": "Unsecured",
"land_value": 550125,
"impr_value": 3521182,
"pers_value": 8553588,
"exempt_value": 89313,
"net_value": 12535582,
"detail_link": "https://beta.urbics.com/api/reports/largest-by-roll-type/json?filter%5Broll%5D=uns&filter%5Byear%5D=2020"
},
{
"roll_type": "Utility",
"land_value": 0,
"impr_value": 0,
"pers_value": 0,
"exempt_value": 0,
"net_value": 0,
"detail_link": "https://beta.urbics.com/api/reports/largest-by-roll-type/json?filter%5Broll%5D=uti&filter%5Byear%5D=2020"
},
{
"roll_type": "Totals",
"land_value": 127596730,
"impr_value": 448399364,
"pers_value": 12160364,
"exempt_value": 22908760,
"net_value": 565247698,
"detail_link": "https://beta.urbics.com/api/reports/largest-by-roll-type"
}
],
"meta": {
"report": {
"parent_area_name": "",
"area_name": "City of Angels Camp",
"county_name": "Calaveras",
"state_abbr": "CA",
"title": "Total Valuation By Roll Type",
"fiscal_year": "2020-21"
},
"fields": {
"roll_type": {
"label": "Roll Type",
"description": "The roll category.",
"data_type": "string",
"data_decimals": 0
},
"land_value": {
"label": "Land",
"description": "Assessed value of land",
"data_type": "integer",
"data_decimals": 0
},
"impr_value": {
"label": "Improvements",
"description": "Assessed value of improvements",
"data_type": "integer",
"data_decimals": 0
},
"pers_value": {
"label": "Personal Property",
"description": "Assessed value of personal property",
"data_type": "integer",
"data_decimals": 0
},
"exempt_value": {
"label": "Exemptions",
"description": "Assessed value of all exemptions",
"data_type": "integer",
"data_decimals": 0
},
"net_value": {
"label": "Net Taxable",
"description": "Assessed value of all property less exemptions",
"data_type": "integer",
"data_decimals": 0
},
"detail_link": {
"label": "Detail",
"description": "Link to related url.",
"data_type": "text",
"data_decimals": 0
}
}
},
"links": {
"self": "https://beta.urbics.com/api/reports/av-totals/json"
}
}
A successful xml request will return the same information in XML format.
An unsuccessful request will return an HTTP error code, and possibly a more descriptive error message generated by Urbics.
Tokens are restricted to use by you as an Urbics subscriber, and are subject to the same terms and conditions that apply to your use of Urbics.