Skip to content

API Documentation

Ian MacFarland edited this page Aug 9, 2017 · 17 revisions

This is an informal documentation of the Open Budget Oakland API as of 18 April 2017

Glossary

Budget Type

Budget types are numbered 1, 2, 3 as follows:

  1. Adopted budget passed by the City Council
  2. Midcycle adjustment to the budget passed by the City Council
  3. Budget proposed by the mayor at the beginning of the 2-year cycle

Fiscal Year Range

Each fiscal year starts on July 1. For this reason, although it only lasts a year, a fiscal year has to be described as a range between successive years, e.g., fiscal year 2013 - 2014.

Budget Expense endpoints

(examples are shown using "FY13-14" for the fiscal year parameter)

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-expenses/

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "total": "1094533634"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "total": "1090122151"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-expenses/accounts/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_description": "Accounting and Auditing Services",
    "total": "4253658"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_description": "Adjustments: Miscellaneous Payroll (Not Subject to Retirement)",
    "total": "-5030292"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-expenses/account-cats/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_category": " Allowances & Premiums",
    "total": "14355017"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_category": " Misc. Personnel Adjustments",
    "total": "4466133"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-expenses/depts/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "department": "Administrative Services",
    "total": "50539644"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "department": "Capital Improvement Projects",
    "total": "27455500"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-expenses/funds/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "fund_description": "2012 Refunding Reassessment Bonds-Debt Service",
    "total": "432991"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "fund_description": "Alameda County: Emergency Dispatch Service Supplemental Assessment",
    "total": "1913935"
  },
  ...

Budget Revenue endpoints

(again, examples are shown using "FY13-14" for the fiscal year parameter)

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-revenue/

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "total": "1094522416"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "total": "1090238743"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-revenue/accounts/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_description": "City Oakland Grant: Community Development Block Grant",
    "total": "6655657"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_description": "City Oakland Grant: Community Services Block Grant",
    "total": "1241775"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-revenue/account-cats/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_category": "Business License Tax",
    "total": "59240000"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "account_category": "Fines & Penalties",
    "total": "27219589"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-revenue/depts/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "department": "Administrative Services",
    "total": "473419942"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "department": "Capital Improvement Projects",
    "total": "1500000"
  },
  ...

http://dev-open-budget-oakland-administration.pantheonsite.io/wp-json/obo/v1/fiscal-years-revenue/funds/FY13-14

returns an array with items like:

[
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "fund_description": "2012 Refunding Reassessment Bonds-Debt Service",
    "total": "432991"
  },
  {
    "budget_type": "1",
    "fiscal_year_range": "FY13-14",
    "fund_description": "Alameda County: Emergency Dispatch Service Supplemental Assessment",
    "total": "1913935"
  },
  ...
You can’t perform that action at this time.