# Phdscanner — 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 browse PhD opportunities and professor postings from PhDScanner.com to find programs that match your academic interests and career goals. Filter through detailed opportunity listings to compare research areas, institutions, and supervisors all in one place.

**Category:** Education | **Website:** [www.phdscanner.com/](https://www.phdscanner.com/) | **Docs:** [parse.bot/marketplace/213ba9dc-b996-4048-a231-62508f3c5c2d/phdscanner-com-api](https://parse.bot/marketplace/213ba9dc-b996-4048-a231-62508f3c5c2d/phdscanner-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/phdscanner/`
**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 opportunity

Get full details of a single PhD opportunity by its ID, including the complete HTML description, supervisor contact information, and application details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `opportunity_id` | string | Yes | UUID of the PhD opportunity (from search_opportunities results). |

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

### List phd postings

List PhD position postings shared by professors on LinkedIn. Returns professor details, university, department, and the post content.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of postings to return. |
| `offset` | integer | No | Pagination offset. |

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

### Search opportunities

Search PhD opportunities with optional filters for country, university, and funding status. Returns paginated results sorted by most recent. Each result includes title, university, location, discipline, supervisor, funding details, and an AI-generated summary.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country` | string | No | Filter by country name (e.g. Germany, Netherlands, United Kingdom, Switzerland, Australia). |
| `funded` | string | No | Filter for fully funded positions only. Pass 'true' to include only fully funded positions. |
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | Pagination offset (number of results to skip). |
| `university` | string | No | Filter by university name (e.g. EPFL, University of Vienna, TU Dresden, Technical University of Munich). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/phdscanner/search-opportunities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"country":"<string>","funded":"<string>","limit":"<integer>","offset":"<integer>","university":"<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.