How to Use YAAPI

Everything you need to go from zero to querying powerful public datasets — in under 5 minutes.

1. 🔑 Request Your API Key

Visit www.yaapi.app/api-keys.html and enter your email. A free API key will be sent to your inbox instantly.

2. 🔍 Explore Available Datasets

Browse live datasets at www.yaapi.app/endpoints.html. Each dataset now includes:

Slug – unique identifier like noaa_global_surface_summary_of_day
Endpoint – full API URL to access the dataset (requires API key)
Schema – structured column info in JSON format
UI – sample viewer page for previewing results

3. 📊 View the Schema

Just append /schema to the dataset endpoint:

/schema');

4. 📥 Query with curl

Use your API key in the x-api-key header:

curl -H "x-api-key: YOUR_KEY" "https://api.yaapi.app/api/employee_payroll_data_fmps_payroll_costing"

Add filters using column values as query params:

curl -H "x-api-key: YOUR_KEY" "https://api.yaapi.app/api/employee_payroll_data_fmps_payroll_costing?fund_code=F0100&payroll_year=2023"

Paginate using limit and offset:

curl -H "x-api-key: YOUR_KEY" "https://api.yaapi.app/api/employee_payroll_data_fmps_payroll_costing?limit=10&offset=20"

5. 🧾 Sample JSON Response

[ { "amount": 2434.0, "fund_type": "CORPORATE FUND", "fund": "F0100 - CORPORATE FUND", "department_function": "City Development", "department": "D54 - Department of Planning and Development", "appropriation": "A0005 - SALARIES AND WAGES - ON PAYROLL", "title": "T0313 - ASST COMMISSIONER", "employee_dataset_id": "EID0058944", "employee": "EID0058944 - DOE, JOHN A", "pay_element": "REGULAR SALARY", "payroll_year": 2025, "payroll_period": 1, "department_code": "D54", "fund_code": "F0100", "appropriation_code": "A0005", "title_code": "T0313" }, ... ]

6. 📬 Questions or Support?

Reach us at www.yaapi.app/contact.html or reply to your API key email for help.