Developer Documentation
Comprehensive salary and compensation reference for job seekers, HR professionals, and employers. Covers salary data by country, city, and job role with cost of living, tax brackets, benefits, interactive calculators, country and role comparisons, glossary, and in-depth guides. 15 languages supported.
- Countries with average salary, minimum wage, tax structure, and cost of living
- Cities with salary data and cost of living indices
- Job roles with salary ranges across countries
- Salary data — country × role combinations with median, percentiles
- Tax brackets by country with effective rate calculations
- Employee benefits comparison by country
- Country-to-country salary comparisons
- Role-to-role salary comparisons
- Interactive tools: tax calculator, salary converter, cost of living adjuster, take-home pay, worldwide comparison, raise calculator, freelance rate, employer cost
- Compensation glossary with HR and payroll terminology
- In-depth guides on salary negotiation, compensation, relocation
Quick Start
curl -s "https://salaryfyi.com/api/v1/countries/"
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/countries/ | Countries with salary data |
| GET | /api/v1/countries/{slug}/ | Country detail |
| GET | /api/v1/cities/ | Cities |
| GET | /api/v1/roles/ | Job roles |
| GET | /api/v1/salary/ | Salary records |
| GET | /api/v1/glossary/ | Glossary terms |
| GET | /api/v1/guides/ | Guide articles |
| GET | /api/v1/faqs/ | FAQs |
| GET | /api/v1/stats/ | Site statistics |
| GET | /api/v1/search/?q={query} | Search across all content |
URL Patterns
Use these patterns to construct URLs programmatically:
/countries/
Browse countries with salary data (e.g. /countries/)
/countries/{slug}/
Country salary detail (e.g. /countries/united-states/)
/cities/
Browse cities (e.g. /cities/)
/cities/{slug}/
City salary detail (e.g. /cities/san-francisco/)
/roles/
Job roles (e.g. /roles/)
/roles/{slug}/
Role salary detail (e.g. /roles/software-engineer/)
/salary/{country}/{role}/
Country×role salary (e.g. /salary/united-states/software-engineer/)
/compare/{slug_a}/vs/{slug_b}/
Country comparison (e.g. /compare/united-states/vs/united-kingdom/)
/compare/roles/{slug_a}/vs/{slug_b}/
Role comparison (e.g. /compare/roles/software-engineer/vs/data-scientist/)
/tools/
Interactive tools (e.g. /tools/)
/tools/tax-calculator/
Tax calculator (e.g. /tools/tax-calculator/)
/tools/salary-converter/
Salary converter (e.g. /tools/salary-converter/)
/tools/cost-of-living-adjuster/
Cost of living adjuster (e.g. /tools/cost-of-living-adjuster/)
/tools/take-home-pay/
Take-home pay calculator (e.g. /tools/take-home-pay/)
/tools/salary-worldwide/
Worldwide salary comparison (e.g. /tools/salary-worldwide/)
/tools/raise-calculator/
Raise calculator (e.g. /tools/raise-calculator/)
/tools/freelance-rate/
Freelance rate calculator (e.g. /tools/freelance-rate/)
/tools/employer-cost/
Employer cost calculator (e.g. /tools/employer-cost/)
/glossary/
Compensation glossary (e.g. /glossary/)
/glossary/{slug}/
Glossary term detail (e.g. /glossary/gross-salary/)
/guides/
In-depth guides (e.g. /guides/)
/guides/{slug}/
Guide detail (e.g. /guides/salary-negotiation/)
/reports/
Salary reports (e.g. /reports/)
/faq/
FAQ (e.g. /faq/)
/search/
Search countries, roles, glossary (e.g. /search/?q=engineer)
Response Format
All endpoints return JSON with pagination:
Example JSON response
{
"count": 636,
"next": "https://example.com/api/v1/items/?page=2",
"previous": null,
"results": [
{"slug": "example", "name": "Example Item", "...": "..."}
]
}
OpenAPI Specification
Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.
SDK Packages
PyPI
pip install salaryfyi
Salary comparison and tax calculator API client
Embed Widget
Embed data cards on your site:
https://widget.salaryfyi.com
npm install salaryfyi-embed
Format Support
- Markdown endpoints: Append
.mdto any page URL for LLM-friendly markdown output. - Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.