# /studyinjapan/scholarships/search

`POST /api/studyinjapan/scholarships/search`

Price: 5 credits

Search the scholarships, fee reductions and tuition exemptions for international students in Japan listed on Study in Japan, by provider name, provider kind, course of study, kind of support, pre-arrival notification, applicant region and residence status. Returns each programme's id, name, kinds of support, eligible courses, provider and last update date

## How to use it

Filters combine with AND. Several `support_types` also combine with AND: a scholarship must offer every kind listed. Several `academic_levels` or several `regions` combine with OR. The ja catalogue lists more scholarships than en. Pass a returned `id` to studyinjapan/scholarships for amounts, periods and selection details.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, nullable) — Words to search for in school and organisation names (examples: "Aichi", "大学")
- `providers` (array, nullable) — Who offers the support: a school or a scholarship organisation (one of: "school", "organization"; examples: ["school"])
- `academic_levels` (array, nullable) — Courses of study the support is open to; several levels combine with OR (one of: "doctoral", "five_year_doctoral", "master", "professional_degree", "graduate_research_student", "bachelor", "undergraduate_research_student", "undergraduate_auditing_student", "advanced_course", "university_japanese_programme", "junior_college", "specialized_training_college", "college_of_technology", "japanese_language_institution", "high_school"; examples: ["master","doctoral"])
- `support_types` (array, nullable) — Kinds of support offered; several kinds combine with AND (one of: "scholarship", "enrollment_fee_reduction", "tuition_reduction", "examination_fee_reduction", "pre_arrival_lump_sum", "other"; examples: ["scholarship","tuition_reduction"])
- `is_notified_before_arrival` (boolean, nullable) — True keeps support whose award is notified before arrival in Japan (examples: true)
- `regions` (array, nullable) — Regions applicants may come from; several regions combine with OR (one of: "asia", "middle_east", "africa", "oceania", "north_america", "central_and_south_america", "europe"; examples: ["asia"])
- `allows_other_residence_status` (boolean, nullable) — True keeps support open to residence statuses other than Student (examples: true)
- `sort` (string) — Order of results by name (default: "name_asc"; one of: "name_asc", "name_desc")
- `language` (string) — Catalogue language: en for the English pages, ja for the full Japanese catalogue (default: "en"; one of: "en", "ja")
- `offset` (integer) — Number of matching results to skip (default: 0; min: 0)
- `count` (integer, required) — Max number of scholarships to return (min: 1; max: 1100)

## Response

### 200 — Successful Response

- `@type` (string) (default: "StudyinjapanScholarshipCard")
- `id` (string, required)
- `name` (string, nullable)
- `support_types` (array, nullable)
- `academic_levels` (array, nullable)
- `provider` (object, required)
  - `@type` (string) (default: "StudyinjapanScholarshipProvider")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `name_en` (string, nullable)
  - `name_kana` (string, nullable)
  - `ownership` (string, nullable)
  - `prefectures` (array, nullable)
  - `image` (string, nullable)
- `updated_date` (integer, nullable)
- `url` (string, required)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.

