{ "openapi": "3.1.0", "info": { "title": "CareerPulse", "description": "Global career intelligence API serving the world's 3.5 billion workers. 10 endpoints: salary benchmarking (any role + any country, sourced from BLS, OECD, ILO, Glassdoor, Levels.fyi), industry outlook, skills-gap analysis (with Coursera/Udemy/Pluralsight course links), ATS-optimized resume intelligence, salary negotiation playbooks, career transition roadmaps, remote work setup intelligence, certification recommendations (with A Cloud Guru/Pluralsight links), interview prep, and layoff/severance guidance. Full global scope — 190+ countries, 75+ languages via ?lang= parameter. LinkedIn Premium and resume builder affiliate links on relevant endpoints. All require x402 micropayment (USDC on Base).", "version": "1.1.0", "contact": { "url": "https://careerpulse.vercel.app" } }, "servers": [{ "url": "https://careerpulse.vercel.app" }], "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "PAYMENT-SIGNATURE", "description": "x402 micropayment signature. Omit to receive 402 with payment requirements. Sign and retry." } } }, "security": [{ "x402": [] }], "paths": { "/api/career/salary": { "get": { "operationId": "careerSalary", "summary": "Salary benchmarking — any role, any country, any experience level", "description": "Real compensation intelligence for any job title in any country. Synthesizes BLS OEWS (US), OECD employment data, ILO ILOSTAT (global), Glassdoor, LinkedIn Salary, Levels.fyi (tech total comp), and Payscale. Returns: median and range by percentile, regional cost-of-living context, equity/bonus norms, total compensation breakdown, trend (growing/stable/declining), and comparison to similar roles. Includes Levels.fyi and Glassdoor resource links + LinkedIn Premium for salary negotiation access. Global coverage — supports 190+ countries with ?lang= parameter.", "parameters": [ { "name": "title", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Product Manager" }, { "name": "location", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Berlin, Germany", "description": "City, region, or country — global coverage" }, { "name": "yoe", "in": "query", "schema": { "type": "string" }, "example": "5", "description": "Years of experience" }, { "name": "lang", "in": "query", "schema": { "type": "string" }, "description": "BCP-47 language code — response in any language" }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Salary benchmarks with percentile ranges, equity norms, trend, and salary data resource links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/career/negotiate for counter-offer playbook using this salary data" } }, "/api/career/outlook": { "get": { "operationId": "careerOutlook", "summary": "Industry job market outlook — growth, hiring trends, top employers by country", "description": "Forward-looking job market intelligence for any sector in any country. Draws from BLS OOH (US Occupational Outlook Handbook), OECD Employment Outlook, ILO World Employment and Social Outlook, Eurostat labor market data, and real-time hiring signals via Tavily. Returns: 5-year growth projection, automation risk score, top hiring employers, salary trend, remote work availability, in-demand skills, and adjacent sectors. Especially valuable for career changers, students choosing majors, and agents building career guidance workflows.", "parameters": [ { "name": "sector", "in": "query", "required": true, "schema": { "type": "string" }, "example": "renewable energy" }, { "name": "country", "in": "query", "schema": { "type": "string" }, "example": "Germany", "description": "Country for localized outlook — defaults to global" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Industry outlook with growth projections, automation risk, top employers, and salary trends" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Pair with /api/career/skills-gap to identify what skills to develop for this sector's growth roles" } }, "/api/career/skills-gap": { "get": { "operationId": "careerSkillsGap", "summary": "Skills gap analysis — exact skills needed to reach your target role", "description": "Precise skills gap analysis between a current role and a target role anywhere in the world. Returns: missing hard skills ranked by hiring frequency, missing certifications, soft skill gaps, recommended learning path with estimated time, and specific courses on Coursera, Udemy, and Pluralsight. Uses O*NET (US), ESCO (EU Skills Framework), and real-time job posting analysis via Tavily. Response includes direct learning platform affiliate links. Global coverage — tech stack requirements differ by region.", "parameters": [ { "name": "current", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Data Analyst" }, { "name": "target", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Machine Learning Engineer" }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Skills gap with ranked missing skills, certifications, learning path, and Coursera/Udemy/Pluralsight links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Response includes learning platform links; pair with /api/career/certify for certification roadmap" } }, "/api/career/resume": { "get": { "operationId": "careerResume", "summary": "ATS-optimized resume intelligence — keywords, format, and recruiter intel by role", "description": "Comprehensive resume optimization for any role and country. Returns: ATS keyword list ranked by frequency, resume format recommendations (chronological vs functional vs hybrid), section-by-section guidance, recruiter red flags to avoid, action verb bank, bullet point formulas (CAR/STAR), country-specific resume norms (photo expectation in Germany/Japan vs. none in US/UK, CV vs resume distinction, length norms by country), and LinkedIn profile tips. Includes Zety and Resume.io tool links + LinkedIn Premium link. Full global format awareness.", "parameters": [ { "name": "role", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Marketing Manager" }, { "name": "industry", "in": "query", "schema": { "type": "string" }, "example": "SaaS" }, { "name": "country", "in": "query", "schema": { "type": "string" }, "description": "Target country — enables country-specific format norms" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resume optimization with ATS keywords, format guidance, recruiter intel, resume builder links, and LinkedIn Premium link" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand" } }, "/api/career/negotiate": { "get": { "operationId": "careerNegotiate", "summary": "Salary negotiation playbook — counter-offer strategy and exact scripts", "description": "Personalized salary negotiation playbook for any job offer in any country. Returns: market-backed counter-offer range with justification script, negotiation strategy (timing, anchoring, silence tactics), exact response scripts for email and phone, counter-offer email template, what else to negotiate beyond base (equity, signing bonus, PTO, remote flex, title), company-size tactics, and cultural negotiation norms by country (e.g. Japan: negotiation is less expected; Netherlands: direct is respected; GCC: relationship-first).", "parameters": [ { "name": "offer", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Offer amount in local currency" }, { "name": "title", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" }, "description": "City/country for market rate and cultural context" }, { "name": "company", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Negotiation playbook with counter-offer range, scripts, email template, and cultural context" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand" } }, "/api/career/transition": { "get": { "operationId": "careerTransition", "summary": "Career transition roadmap — transferable skills analysis and step-by-step pivot plan", "description": "Complete roadmap for transitioning between careers or industries. Analyzes transferable skills, identifies gaps, estimates realistic timeline, and provides step-by-step action plan. Covers: transferable skills from current role, minimum viable qualifications for target, bridge roles, portfolio or project recommendations, communities and networking paths, country-specific job market entry points, and realistic salary expectations during transition. Works for any career change globally — teacher to UX designer, lawyer to product manager, nurse to health tech, military to corporate, any combination.", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string" }, "example": "high school teacher" }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string" }, "example": "UX designer" }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "timeline", "in": "query", "schema": { "type": "string" }, "description": "Desired transition timeline — e.g. 6 months, 1 year" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Career transition roadmap with transferable skills, gaps, timeline, bridge roles, and action plan" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/career/skills-gap for specific skill acquisition plan on the target role" } }, "/api/career/remote": { "get": { "operationId": "careerRemote", "summary": "Remote work intelligence — best remote roles, companies, and cross-border setup", "description": "Comprehensive remote work intelligence for any profession. Returns: top remote-friendly companies hiring globally for this role, time zone overlap requirements, async vs. sync culture indicators, remote pay equity practices (location-adjusted vs. single pay scale), visa and tax considerations for working remotely across borders, home office setup requirements, equipment stipends, and top global remote job platforms (We Work Remotely, Remote.co, Remotive, Himalayas, Turing for developers). Especially valuable for workers in Eastern Europe, Southeast Asia, and Latin America targeting foreign employers.", "parameters": [ { "name": "role", "in": "query", "required": true, "schema": { "type": "string" }, "example": "software engineer" }, { "name": "country", "in": "query", "schema": { "type": "string" }, "description": "Your country — for visa/tax implications of working remotely for foreign companies" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remote work intel with top companies, pay practices, visa context, and job platforms" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Pair with ImmigrationPulse /api/nomad if user wants a digital nomad visa for their remote work country" } }, "/api/career/certify": { "get": { "operationId": "careerCertify", "summary": "Certification roadmap — highest-ROI certs in order, with study resources", "description": "Certification strategy for any career goal. Returns: top certifications ranked by ROI (salary impact vs. cost/time), prerequisite order, study time estimates, exam costs, pass rates, expiration/renewal cadence, employer recognition by region, and direct links to Coursera, Pluralsight, and A Cloud Guru prep courses. Covers: cloud (AWS, Azure, GCP), cybersecurity (CISSP, CompTIA Security+, CEH), data (Databricks, dbt, Snowflake), project management (PMP, PRINCE2, Agile/Scrum), finance (CFA, CPA, FRM), HR (SHRM), legal, medical, and tech (Cisco, Microsoft, Oracle). Regional recognition context included.", "parameters": [ { "name": "role", "in": "query", "required": true, "schema": { "type": "string" }, "example": "cloud architect" }, { "name": "current_certs", "in": "query", "schema": { "type": "string" }, "description": "Comma-separated existing certifications" }, { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Certification roadmap with ROI ranking, exam costs, study resources, and Coursera/Pluralsight links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Response includes direct course links; pair with /api/career/skills-gap for full upskilling plan" } }, "/api/career/interview": { "get": { "operationId": "careerInterview", "summary": "Interview preparation — questions, frameworks, and company research intel", "description": "Comprehensive interview preparation for any role and company. Returns: 20 most likely questions (behavioral + technical), STAR-method answer frameworks, company research brief (values, recent news, products, culture), questions to ask the interviewer, red flags to watch for, compensation discussion timing, and virtual interview best practices. Cultural interview norms included — Japanese formal structure vs. US FAANG loops vs. EU co-determination cultures vs. Middle East relationship-first dynamics. Essential for cross-border interview preparation.", "parameters": [ { "name": "role", "in": "query", "required": true, "schema": { "type": "string" }, "example": "Senior Product Manager" }, { "name": "company", "in": "query", "schema": { "type": "string" } }, { "name": "country", "in": "query", "schema": { "type": "string" }, "description": "Adjusts for cultural interview norms" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interview prep with likely questions, STAR frameworks, company brief, and cultural norms" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand" } }, "/api/career/layoff": { "get": { "operationId": "careerLayoff", "summary": "Layoff support — severance review, legal rights, benefits continuation, next steps", "description": "Comprehensive layoff support for any country. Provides: severance package review (is the offer fair? what's negotiable?), employment law rights by country (WARN Act US, EU Collective Redundancies Directive, UK redundancy rules, Canadian common law entitlements, Australian Fair Work Act, and 50+ more), benefits continuation options, unemployment benefits enrollment steps, emergency budget calculation, 30-day job search action plan, LinkedIn network activation strategy, and mental health resources. Every country has different worker protections — this endpoint is specifically designed for global coverage.", "parameters": [ { "name": "country", "in": "query", "required": true, "schema": { "type": "string" }, "example": "United Kingdom" }, { "name": "industry", "in": "query", "schema": { "type": "string" } }, { "name": "tenure", "in": "query", "schema": { "type": "string" }, "description": "Years at company — affects severance expectations and legal entitlements" }, { "name": "lang", "in": "query", "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Layoff guide with severance review, legal rights, benefits, job search plan, and mental health resources" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.10, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/career/transition for pivot planning, or /api/career/negotiate when new offer arrives" } } } }