# Scholarshipportal — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and discover scholarships, degree programmes, and universities across StudyPortals' global education database, with the ability to filter by countries, disciplines, and other criteria. Get detailed information about specific scholarships and programmes to compare educational opportunities that match your academic interests.

**Category:** Education | **Website:** [scholarshipportal.com/](https://scholarshipportal.com/) | **Docs:** [parse.bot/marketplace/0e51aa9d-8522-4bb1-b0d8-43c51dd65fc8/scholarshipportal-com-api](https://parse.bot/marketplace/0e51aa9d-8522-4bb1-b0d8-43c51dd65fc8/scholarshipportal-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get countries list

Retrieve the list of available countries and their programme counts for a given study level. Useful for discovering valid country_iso values for search filters on search_scholarships and search_programmes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `study_level` | string | No | Study level context. Accepted values: master, bachelor, phd. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/get-countries-list \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"study_level":"<string>"}'
```

### Get disciplines list

Retrieve the list of available academic disciplines and their programme counts for a given study level. Useful for discovering valid discipline_ids values for search filters on search_scholarships and search_programmes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `study_level` | string | No | Study level context. Accepted values: master, bachelor, phd. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/get-disciplines-list \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"study_level":"<string>"}'
```

### Get scholarship details

Get detailed information for a specific scholarship by its ID and slug. Returns structured data including about text, eligibility summary, and JSON-LD metadata. The id and slug are obtained from search_scholarships results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | Yes | Scholarship numeric ID (from search_scholarships results[*].id). |
| `slug` | string | Yes | Scholarship URL slug (from search_scholarships results[*].slug). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/get-scholarship-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"id":"<string>","slug":"<string>"}'
```

### Search programmes

Search for academic programmes (MSc, PhD, etc.) with filters for study level, country, discipline, and keyword. Returns paginated results including university, location, tuition, and duration. Pagination is offset-based.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_iso` | string | No | Two-letter ISO country code to filter by destination country (e.g. CA, US, GB, NL). Discoverable via get_countries_list. |
| `discipline_ids` | string | No | Comma-separated numeric discipline IDs to filter by field of study. Discoverable via get_disciplines_list. |
| `limit` | integer | No | Maximum number of results to return per request. |
| `offset` | integer | No | Pagination offset (number of results to skip). |
| `query` | string | No | Search keyword to filter programmes by title or description. |
| `study_level` | string | No | Study level filter. Accepted values: master, bachelor, phd. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/search-programmes \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"country_iso":"<string>","discipline_ids":"<string>","limit":"<integer>","offset":"<integer>","query":"<string>","study_level":"<string>"}'
```

### Search scholarships

Search for scholarships with filters for study level, country, discipline, and keyword. Returns paginated results. Each scholarship includes grant details, deadline, provider info, and a URL slug for fetching full details via get_scholarship_details. Pagination is offset-based; advance by incrementing offset by limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country_iso` | string | No | Two-letter ISO country code to filter by destination country (e.g. CA, US, GB, NL). Discoverable via get_countries_list. |
| `discipline_ids` | string | No | Comma-separated numeric discipline IDs to filter by field of study. Discoverable via get_disciplines_list. |
| `limit` | integer | No | Maximum number of results to return per request. |
| `offset` | integer | No | Pagination offset (number of results to skip). |
| `query` | string | No | Search keyword to filter scholarships by title or description. |
| `study_level` | string | No | Study level filter. Accepted values: master, bachelor, phd. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/search-scholarships \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"country_iso":"<string>","discipline_ids":"<string>","limit":"<integer>","offset":"<integer>","query":"<string>","study_level":"<string>"}'
```

### Search universities

Search for universities with optional keyword filter. Returns paginated results with summary, location, ranking, and programme/scholarship counts. Pagination is offset-based.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per request. |
| `offset` | integer | No | Pagination offset (number of results to skip). |
| `query` | string | No | Search keyword to filter universities by name. |
| `study_level` | string | No | Study level filter. Accepted values: master, bachelor, phd. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scholarshipportal/search-universities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","query":"<string>","study_level":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.