kaken_api.api package

Submodules

kaken_api.api.projects module

Projects API module for the KAKEN API client.

class kaken_api.api.projects.ProjectsAPI(session, app_id=None)

Bases: object

API client for KAKEN projects.

Parameters:

• session (Session)

• app_id (str | None)

search(keyword=None, results_per_page=20, language='ja', start_index=1, response_format='xml', project_title=None, project_number=None, project_type=None, research_category=None, allocation_type=None, research_field=None, institution=None, grant_period_from=None, grant_period_to=None, grant_period_condition=None, total_grant_amount=None, project_status=None, researcher_name=None, researcher_institution=None, researcher_number=None, researcher_role=None, sort_order=None, **kwargs)

Search for projects.

Parameters:

• keyword (str | None) – Free text search keyword.

• results_per_page (int) – Number of results per page (20, 50, 100, 200, 500).

• language (str) – Response language (ja, en).

• start_index (int) – Start index of results.

• response_format (str) – Response format (html5, xml).

• project_title (str | None) – Project title.

• project_number (str | None) – Project number.

• project_type (str | List[str] | None) – Project type (project, area, organizer, wrapup, planned, publicly, international).

• research_category (str | None) – Research category.

• allocation_type (str | List[str] | None) – Allocation type (hojokin, kikin, ichibu_kikin).

• research_field (str | None) – Research field.

• institution (str | None) – Institution.

• grant_period_from (int | None) – Grant period from (year).

• grant_period_to (int | None) – Grant period to (year).

• grant_period_condition (str | None) – Grant period condition (1: start year, 2: end year, 3: partial period, 4: full period).

• total_grant_amount (str | None) – Total grant amount (1: < 1M, 2: 1M-5M, 3: 5M-10M, 4: 10M-50M, 5: 50M-100M, 6: 100M-500M, 7: > 500M).

• project_status (str | List[str] | None) – Project status (adopted, granted, ceased, suspended, project_closed, declined, discontinued).

• researcher_name (str | None) – Researcher name.

• researcher_institution (str | None) – Researcher institution.

• researcher_number (str | None) – Researcher number.

• researcher_role (str | List[str] | None) – Researcher role (principal_investigator, area_organizer, co_investigator_buntan, co_investigator_renkei, research_collaborator, research_fellow, host_researcher, foreign_research_fellow, principal_investigator_support, co_investigator_buntan_support).

• sort_order (str | None) – Sort order (1: relevance, 2: start year desc, 3: start year asc, 4: total amount desc, 5: total amount asc).

• **kwargs – Additional parameters.

Returns:

The search response.

Return type:

ProjectsResponse

kaken_api.api.researchers module

Researchers API module for the KAKEN API client.

class kaken_api.api.researchers.ResearchersAPI(session, app_id=None)

Bases: object

API client for KAKEN researchers.

Parameters:

• session (Session)

• app_id (str | None)

search(keyword=None, results_per_page=20, language='ja', start_index=1, response_format='json', researcher_name=None, researcher_number=None, researcher_institution=None, researcher_department=None, researcher_job_title=None, project_title=None, project_number=None, research_category=None, research_field=None, institution=None, grant_period_from=None, grant_period_to=None, grant_period_condition=None, sort_order=None, **kwargs)

Search for researchers.

Parameters:

• keyword (str | None) – Free text search keyword.

• results_per_page (int) – Number of results per page (20, 50, 100, 200, 500).

• language (str) – Response language (ja, en).

• start_index (int) – Start index of results.

• response_format (str) – Response format (html5, json).

• researcher_name (str | None) – Researcher name.

• researcher_number (str | None) – Researcher number.

• researcher_institution (str | None) – Researcher institution.

• researcher_department (str | None) – Researcher department.

• researcher_job_title (str | None) – Researcher job title.

• project_title (str | None) – Project title.

• project_number (str | None) – Project number.

• research_category (str | None) – Research category.

• research_field (str | None) – Research field.

• institution (str | None) – Institution.

• grant_period_from (int | None) – Grant period from (year).

• grant_period_to (int | None) – Grant period to (year).

• grant_period_condition (str | None) – Grant period condition (1: start year, 2: end year, 3: partial period, 4: full period).

• sort_order (str | None) – Sort order (1: relevance, 2: name kana asc, 3: name kana desc, 4: name alphabet asc, 5: name alphabet desc, 6: project count asc, 7: project count desc).

• **kwargs – Additional parameters.

Returns:

The search response.

Return type:

ResearchersResponse

Module contents

API modules for the KAKEN API client.

class kaken_api.api.ProjectsAPI(session, app_id=None)

Bases: object

API client for KAKEN projects.

Parameters:

• session (Session)

• app_id (str | None)

search(keyword=None, results_per_page=20, language='ja', start_index=1, response_format='xml', project_title=None, project_number=None, project_type=None, research_category=None, allocation_type=None, research_field=None, institution=None, grant_period_from=None, grant_period_to=None, grant_period_condition=None, total_grant_amount=None, project_status=None, researcher_name=None, researcher_institution=None, researcher_number=None, researcher_role=None, sort_order=None, **kwargs)

Search for projects.

Parameters:

• keyword (str | None) – Free text search keyword.

• results_per_page (int) – Number of results per page (20, 50, 100, 200, 500).

• language (str) – Response language (ja, en).

• start_index (int) – Start index of results.

• response_format (str) – Response format (html5, xml).

• project_title (str | None) – Project title.

• project_number (str | None) – Project number.

• project_type (str | List[str] | None) – Project type (project, area, organizer, wrapup, planned, publicly, international).

• research_category (str | None) – Research category.

• allocation_type (str | List[str] | None) – Allocation type (hojokin, kikin, ichibu_kikin).

• research_field (str | None) – Research field.

• institution (str | None) – Institution.

• grant_period_from (int | None) – Grant period from (year).

• grant_period_to (int | None) – Grant period to (year).

• grant_period_condition (str | None) – Grant period condition (1: start year, 2: end year, 3: partial period, 4: full period).

• total_grant_amount (str | None) – Total grant amount (1: < 1M, 2: 1M-5M, 3: 5M-10M, 4: 10M-50M, 5: 50M-100M, 6: 100M-500M, 7: > 500M).

• project_status (str | List[str] | None) – Project status (adopted, granted, ceased, suspended, project_closed, declined, discontinued).

• researcher_name (str | None) – Researcher name.

• researcher_institution (str | None) – Researcher institution.

• researcher_number (str | None) – Researcher number.

• researcher_role (str | List[str] | None) – Researcher role (principal_investigator, area_organizer, co_investigator_buntan, co_investigator_renkei, research_collaborator, research_fellow, host_researcher, foreign_research_fellow, principal_investigator_support, co_investigator_buntan_support).

• sort_order (str | None) – Sort order (1: relevance, 2: start year desc, 3: start year asc, 4: total amount desc, 5: total amount asc).

• **kwargs – Additional parameters.

Returns:

The search response.

Return type:

ProjectsResponse

class kaken_api.api.ResearchersAPI(session, app_id=None)

Bases: object

API client for KAKEN researchers.

Parameters:

• session (Session)

• app_id (str | None)

search(keyword=None, results_per_page=20, language='ja', start_index=1, response_format='json', researcher_name=None, researcher_number=None, researcher_institution=None, researcher_department=None, researcher_job_title=None, project_title=None, project_number=None, research_category=None, research_field=None, institution=None, grant_period_from=None, grant_period_to=None, grant_period_condition=None, sort_order=None, **kwargs)

Search for researchers.

Parameters:

• keyword (str | None) – Free text search keyword.

• results_per_page (int) – Number of results per page (20, 50, 100, 200, 500).

• language (str) – Response language (ja, en).

• start_index (int) – Start index of results.

• response_format (str) – Response format (html5, json).

• researcher_name (str | None) – Researcher name.

• researcher_number (str | None) – Researcher number.

• researcher_institution (str | None) – Researcher institution.

• researcher_department (str | None) – Researcher department.

• researcher_job_title (str | None) – Researcher job title.

• project_title (str | None) – Project title.

• project_number (str | None) – Project number.

• research_category (str | None) – Research category.

• research_field (str | None) – Research field.

• institution (str | None) – Institution.

• grant_period_from (int | None) – Grant period from (year).

• grant_period_to (int | None) – Grant period to (year).

• grant_period_condition (str | None) – Grant period condition (1: start year, 2: end year, 3: partial period, 4: full period).

• sort_order (str | None) – Sort order (1: relevance, 2: name kana asc, 3: name kana desc, 4: name alphabet asc, 5: name alphabet desc, 6: project count asc, 7: project count desc).

• **kwargs – Additional parameters.

Returns:

The search response.

Return type:

ResearchersResponse