Use Compass

Compass provides structured access to Philippine budget execution, allocation, release, and Local Government Support Fund records.

Compass operations are read-only queries, but access still requires the API key issued to your integration.

Query model

Pass request filters under the operation's query object. Required year, period, scope, and program fields vary by dataset.

Initialize the client

Create a dedicated client with the Compass API key issued to your integration:

12345678import { createClient } from "egov.js";

const client = createClient({
  baseUrl: "https://dbm-ws.oueg.info",
  headers: {
    "x-api-key": process.env.EGOVCOMPASS_API_KEY!,
  },
});

Methods

The examples below use this authenticated Compass client. See the quickstart for the general client pattern.

The API Reference tab remains the source of truth for complete query parameters, response schemas, and cURL examples.

`compass.getSaaodbRecords`

GET /api/v1/records/saaodb returns paginated SAAODB budget-execution records filtered by year, period, scope, entity, or expense class.

123456789101112import { compass } from "egov.js";

const saaodb = await compass.getSaaodbRecords({
  client,
  query: {
    period: "FY",
    reportYear: 2026,
    page: 1,
    limit: 25,
  },
  throwOnError: true,
});

`compass.getSaaodbDashboard`

GET /api/v1/records/saaodb/dashboard returns aggregated SAAODB figures for the requested report year and sheet scope.

12345678910import { compass } from "egov.js";

const saaodbDashboard = await compass.getSaaodbDashboard({
  client,
  query: {
    reportYear: 2026,
    sheetScope: "summary",
  },
  throwOnError: true,
});

`compass.getSaaodbEntities`

GET /api/v1/records/saaodb/entities returns department, agency, and fund-source relationships for navigating SAAODB data.

12345678910import { compass } from "egov.js";

const entities = await compass.getSaaodbEntities({
  client,
  query: {
    reportYear: 2026,
    sheetScope: "agency",
  },
  throwOnError: true,
});

`compass.getNcaRecords`

GET /api/v1/records/nca returns paginated Notice of Cash Allocation records for a budget year and optional organization filters.

1234567891011import { compass } from "egov.js";

const nca = await compass.getNcaRecords({
  client,
  query: {
    budgetYear: 2026,
    page: 1,
    limit: 25,
  },
  throwOnError: true,
});

`compass.getSaroRecords`

GET /api/v1/records/saro returns paginated Special Allotment Release Order records with optional release and agency filters.

1234567import { compass } from "egov.js";

const saro = await compass.getSaroRecords({
  client,
  query: { page: 1, limit: 25 },
  throwOnError: true,
});

`compass.getLgsfRecords`

GET /api/v1/records/lgsf returns paginated Local Government Support Fund records with optional program and location filters.

123456789101112import { compass } from "egov.js";

const lgsf = await compass.getLgsfRecords({
  client,
  query: {
    fiscalYear: 2026,
    programCode: "FALGU",
    page: 1,
    limit: 25,
  },
  throwOnError: true,
});

`compass.getLgsfDashboard`

GET /api/v1/records/lgsf/dashboard returns LGSF KPIs, trends, and projects for the requested program and optional location filters.

12345678910import { compass } from "egov.js";

const lgsfDashboard = await compass.getLgsfDashboard({
  client,
  query: {
    programCode: "FALGU",
    reportYear: 2026,
  },
  throwOnError: true,
});

View the provider catalog