{
  "name": "ScholarPulse",
  "description": "Global scholarship and student finance intelligence API. Covers 190+ countries: scholarship search by profile, cross-border funding (Chevening, DAAD, Fulbright, Erasmus+, Commonwealth, CSC, MEXT, Türkiye Bursları, and 50+ government programs), US financial aid via College Scorecard, FAFSA strategy, student loan repayment (US SAVE/IBR/PAYE, UK Plan 2/5, Australia HELP, Canada RAP), loan forgiveness (PSLF, TEACH, state programs, profession-specific), degree ROI analysis, merit aid strategy, scholarship deadlines, and essay coaching. Pay-per-query via x402 micropayments on Base.",
  "url": "https://scholarpulse-bice.vercel.app",
  "version": "1.0.0",
  "capabilities": [
    "scholarship-search",
    "international-scholarship-matching",
    "government-program-lookup",
    "erasmus-plus-guidance",
    "financial-aid-estimation",
    "fafsa-strategy",
    "student-loan-repayment",
    "loan-forgiveness-assessment",
    "degree-roi-analysis",
    "merit-aid-strategy",
    "scholarship-deadlines",
    "essay-strategy",
    "college-scorecard-data",
    "global-education-funding",
    "cross-border-education"
  ],
  "global_coverage": {
    "regions": ["North America", "Europe", "Asia-Pacific", "South Asia", "MENA", "Africa", "Latin America"],
    "scholarship_programs": [
      "US: Pell Grant, TEACH, state grants, institutional merit",
      "UK: Chevening, Commonwealth, Marshall, Rhodes, Gates Cambridge",
      "EU: Erasmus+ (KA131/KA171), Erasmus Mundus, Marie Curie",
      "Germany: DAAD, Deutschlandstipendium, Alexander von Humboldt",
      "Japan: MEXT, JASSO",
      "South Korea: GKS/KGSP, Brain Korea 21",
      "China: CSC (Chinese Government Scholarship)",
      "Turkey: Türkiye Bursları",
      "Australia: Australia Awards, Endeavour",
      "Canada: Vanier, Trudeau Foundation",
      "Africa: Mastercard Foundation Scholars",
      "Global: Fulbright, Aga Khan, World Bank, Islamic Development Bank"
    ],
    "loan_systems": ["US Federal (SAVE/IBR/PAYE/PSLF)", "UK Plan 2/5", "Australia HELP/HECS", "Canada RAP", "New Zealand"]
  },
  "data_sources": [
    "College Scorecard API (US federal — net cost, aid, earnings by institution)",
    "Tavily real-time web search (scholarship databases, deadlines, program details)",
    "Claude knowledge base (global program details, FAFSA rules, forgiveness eligibility)"
  ],
  "payment": {
    "protocol": "x402",
    "network": "eip155:8453",
    "asset": "USDC",
    "contract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "payTo": "0x50ab2018c06c6E4eAA9BA52057Eb55eD284912fc"
  },
  "endpoints": [
    {
      "path": "/api/search",
      "method": "GET",
      "description": "Scholarship search by academic profile — finds matched scholarships globally from real-time sources, sorted by match strength and deadline urgency. Covers 190+ countries.",
      "parameters": [
        {"name": "major", "in": "query", "required": true, "description": "Field of study (e.g. nursing, engineering, computer-science)"},
        {"name": "country", "in": "query", "required": false, "description": "Country to search scholarships for (default: US)"},
        {"name": "level", "in": "query", "required": false, "description": "undergraduate | graduate | phd | professional"},
        {"name": "gpa", "in": "query", "required": false, "description": "GPA for need-based filtering"},
        {"name": "income", "in": "query", "required": false, "description": "Household income for need-based filtering"},
        {"name": "demographic", "in": "query", "required": false, "description": "first-gen | veteran | international | stem-women"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language (default: English)"}
      ],
      "price_usd": 0.15,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/global",
      "method": "GET",
      "description": "Cross-border scholarship matching for international students — covers Chevening, DAAD, Fulbright, Commonwealth, Erasmus Mundus, CSC, MEXT, GKS, Türkiye Bursları, and all major government programs by nationality/destination pair.",
      "parameters": [
        {"name": "nationality", "in": "query", "required": true, "description": "Student's nationality (e.g. Indian, Nigerian, Brazilian)"},
        {"name": "destination", "in": "query", "required": true, "description": "Target country to study in (e.g. UK, Germany, USA)"},
        {"name": "level", "in": "query", "required": false, "description": "undergraduate | masters | phd"},
        {"name": "field", "in": "query", "required": false, "description": "Field of study"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.15,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/government",
      "method": "GET",
      "description": "Official government scholarship and student aid programs by country — India NSP, US Pell/TEACH, UK Student Finance, Germany BAföG, Japan MEXT/JASSO, South Africa NSFAS, Brazil ProUni/FIES, and 50+ country programs.",
      "parameters": [
        {"name": "country", "in": "query", "required": true, "description": "Country name"},
        {"name": "level", "in": "query", "required": false, "description": "undergraduate | graduate | phd | vocational"},
        {"name": "field", "in": "query", "required": false, "description": "Optional field filter"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.10,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/erasmus",
      "method": "GET",
      "description": "Erasmus+ program guide — monthly grant amounts by country group, KA131 vs KA171 vs Erasmus Mundus eligibility, application process, partner universities, and OLP language tool. Covers 33 countries, 800+ universities.",
      "parameters": [
        {"name": "from", "in": "query", "required": true, "description": "Home country (EU/EEA)"},
        {"name": "to", "in": "query", "required": true, "description": "Host country"},
        {"name": "field", "in": "query", "required": false, "description": "Field of study"},
        {"name": "level", "in": "query", "required": false, "description": "undergraduate | masters | phd"},
        {"name": "duration", "in": "query", "required": false, "description": "Duration in months (2-12)"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.08,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/aid",
      "method": "GET",
      "description": "US college financial aid package estimate using College Scorecard federal data — net price by income bracket, Pell eligibility, institutional generosity analysis, 4-year cost estimate, and negotiation leverage.",
      "parameters": [
        {"name": "college", "in": "query", "required": true, "description": "US college or university name"},
        {"name": "income", "in": "query", "required": true, "description": "Household AGI"},
        {"name": "family_size", "in": "query", "required": false, "description": "Number of people in household (default: 4)"},
        {"name": "assets", "in": "query", "required": false, "description": "Reportable assets (exclude retirement accounts)"},
        {"name": "dependency_status", "in": "query", "required": false, "description": "dependent | independent"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.12,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/fafsa",
      "method": "GET",
      "description": "FAFSA strategy — Student Aid Index estimate, Pell eligibility, maximize-aid action plan, asset strategy (what counts vs exempt), common mistakes, and priority filing deadlines.",
      "parameters": [
        {"name": "income", "in": "query", "required": true, "description": "Household AGI"},
        {"name": "family_size", "in": "query", "required": false, "description": "Household size"},
        {"name": "assets", "in": "query", "required": false, "description": "Reportable assets (NOT retirement accounts)"},
        {"name": "year", "in": "query", "required": false, "description": "freshman | sophomore | junior | senior | graduate"},
        {"name": "dependency_status", "in": "query", "required": false, "description": "dependent | independent"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.10,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/loans",
      "method": "GET",
      "description": "Student loan repayment strategy — compares all applicable plans (US: SAVE/IBR/PAYE/ICR/Standard, UK: Plan 2/5, Australia: HELP, Canada: RAP) with monthly payment, total cost, payoff timeline, and refinancing analysis.",
      "parameters": [
        {"name": "country", "in": "query", "required": false, "description": "US | UK | Australia | Canada | New Zealand (default: US)"},
        {"name": "balance", "in": "query", "required": true, "description": "Total loan balance"},
        {"name": "income", "in": "query", "required": true, "description": "Annual income"},
        {"name": "loan_type", "in": "query", "required": false, "description": "federal | private | HELP | Plan2 | OSAP"},
        {"name": "family_size", "in": "query", "required": false, "description": "For US IDR plan calculations"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.12,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/forgiveness",
      "method": "GET",
      "description": "Student loan forgiveness eligibility — PSLF (with payment count estimate), TEACH Grant, Nurse Corps, NHSC, military programs, state-specific programs, and profession-specific forgiveness with action plan.",
      "parameters": [
        {"name": "profession", "in": "query", "required": true, "description": "teacher | nurse | doctor | social-worker | lawyer | military | government-employee | researcher"},
        {"name": "employer_type", "in": "query", "required": false, "description": "public-school | nonprofit | government | private"},
        {"name": "country", "in": "query", "required": false, "description": "Country (default: US)"},
        {"name": "state", "in": "query", "required": false, "description": "US state for state-specific programs"},
        {"name": "years_in_service", "in": "query", "required": false, "description": "Years in qualifying employment"},
        {"name": "loan_type", "in": "query", "required": false, "description": "federal | private"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.10,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/roi",
      "method": "GET",
      "description": "Degree ROI analysis — median earnings by major/level (College Scorecard + BLS), debt-to-income ratio, payoff timeline, comparison to alternatives (bootcamp, trade school, community college), and honest verdict.",
      "parameters": [
        {"name": "major", "in": "query", "required": true, "description": "Field of study"},
        {"name": "degree_level", "in": "query", "required": false, "description": "bachelor | master | phd | associate | professional"},
        {"name": "debt", "in": "query", "required": true, "description": "Total expected debt at graduation"},
        {"name": "college", "in": "query", "required": false, "description": "College name for institution-specific earnings data"},
        {"name": "country", "in": "query", "required": false, "description": "Country (default: US)"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.10,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/merit",
      "method": "GET",
      "description": "Merit aid strategy — identifies colleges with automatic merit scholarships for this GPA/test score profile, including state programs (FL Bright Futures, GA HOPE, LA TOPS, WV full tuition), with net cost estimates and stacking strategy.",
      "parameters": [
        {"name": "gpa", "in": "query", "required": true, "description": "Unweighted GPA (e.g. 3.8)"},
        {"name": "test_score", "in": "query", "required": false, "description": "SAT 1400 | ACT 32 | IB 38"},
        {"name": "major", "in": "query", "required": false, "description": "Intended major"},
        {"name": "state", "in": "query", "required": false, "description": "Home state for state merit programs"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.12,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    },
    {
      "path": "/api/deadline",
      "method": "GET",
      "description": "Upcoming scholarship deadlines — real-time deadline tracker sorted by urgency, with requirements, amounts, difficulty rating, and quick-win opportunities. Global coverage.",
      "parameters": [
        {"name": "country", "in": "query", "required": false, "description": "Country (default: US)"},
        {"name": "major", "in": "query", "required": false, "description": "Field of study filter"},
        {"name": "level", "in": "query", "required": false, "description": "undergraduate | graduate | phd"},
        {"name": "month", "in": "query", "required": false, "description": "next | this-month | next-3-months"},
        {"name": "state", "in": "query", "required": false, "description": "US state for local scholarships"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.08,
      "payment_required": true,
      "x-agent-use-case": "poll-weekly"
    },
    {
      "path": "/api/essay",
      "method": "GET",
      "description": "Scholarship essay strategy — committee values, optimal angle, structure, voice, and insider tips specific to each scholarship. Strategic coaching only (not AI-generated essay).",
      "parameters": [
        {"name": "scholarship", "in": "query", "required": true, "description": "Scholarship name (e.g. Gates Scholarship, Chevening, DAAD)"},
        {"name": "prompt", "in": "query", "required": true, "description": "The essay prompt"},
        {"name": "word_limit", "in": "query", "required": false, "description": "Word limit"},
        {"name": "background", "in": "query", "required": false, "description": "Brief student background context"},
        {"name": "lang", "in": "query", "required": false, "description": "Response language"}
      ],
      "price_usd": 0.10,
      "payment_required": true,
      "x-agent-use-case": "on-demand"
    }
  ],
  "openapi": "https://scholarpulse-bice.vercel.app/openapi.json",
  "llms_txt": "https://scholarpulse-bice.vercel.app/llms.txt",
  "contact": "https://scholarpulse-bice.vercel.app"
}
