Class KENALL

Constructors

constructor

new KENALL(apikey: string, config?: Config): KENALL
The constructor.
Parameters
- apikey: string
  The key string that you want to call the API with. The key is shown in the dashboard you will be navigated to right after signing in to the service.
- config: Config = {}
  Specifies the configuration given by Config.
Returns KENALL
- Defined in v1/core.ts:64

Properties

`Readonly`apibase

apibase: string

`Readonly`apikey

apikey: string

The key string that you want to call the API with. The key is shown in the dashboard you will be navigated to right after signing in to the service.

`Readonly`timeout

timeout: number

Methods

checkBusinessDay

checkBusinessDay(date: string): Promise<v20250101.BusinessDayCheckResponse>
"checkBusinessDay" API (エンドポイント: /businessdays/check) を呼び出します。

このAPIはバージョン管理されていません。
Parameters
- date: string
  "checkBusinessDay" API (エンドポイント: /businessdays/check) を呼び出します。
  
  このAPIはバージョン管理されていません。
Returns Promise<v20250101.BusinessDayCheckResponse>
A BusinessDayCheckResponse.
- Defined in v1/core.ts:610

getAddress

getAddress<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    postalCode: string,
    version?: string,
    apiVersion?: T,
): Promise<AddressResolverResponseForVersion<T>>
"getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- postalCode: string
  "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。
- Optionalversion: string
  "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。
- OptionalapiVersion: T
  "getAddress" API (エンドポイント: /postalcode/{postalcode}) を呼び出します。
Returns Promise<AddressResolverResponseForVersion<T>>
An AddressResolverResponse.
- Defined in v1/core.ts:119

getBank

getBank<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    bankCode: string,
    apiVersion?: T,
): Promise<BankResolverResponseForVersion<T>>
Invokes "getBank" API (endpoint: /bank/{bankCode}).
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- bankCode: string
  The bank code to query with.
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BankResolverResponseForVersion<T>>
A BankResolverResponse.
- Defined in v1/core.ts:424

getBankBranch

getBankBranch<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    bankCode: string,
    branchCode: string,
    apiVersion?: T,
): Promise<BankBranchResolverResponseForVersion<T>>
Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches/{branchCode}).
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- bankCode: string
  The bank code to query with.
- branchCode: string
  The branch code to query with.
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BankBranchResolverResponseForVersion<T>>
A BankBranchResolverResponse.
- Defined in v1/core.ts:541

getBankBranches

getBankBranches<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    bankCode: string,
    apiVersion?: T,
): Promise<BankBranchesResponseForVersion<T>>
Invokes "getBankBranch" API (endpoint: /bank/{bankCode}/branches).
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- bankCode: string
  The bank code to query with.
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BankBranchesResponseForVersion<T>>
A BankBranchesResponse.
- Defined in v1/core.ts:455

getBanks

getBanks<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    apiVersion?: T,
): Promise<BanksResponseForVersion<T>>
Invokes "getBanks" API (endpoint: /bank).
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BanksResponseForVersion<T>>
A BanksResponse.
- Defined in v1/core.ts:349

getCities

getCities<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    prefectureCode: string,
    version?: string,
    apiVersion?: T,
): Promise<CityResolverResponseForVersion<T>>
"getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- prefectureCode: string
  "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。
- Optionalversion: string
  "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。
- OptionalapiVersion: T
  "getCities" API (エンドポイント: /cities/{prefectureCode}) を呼び出します。
Returns Promise<CityResolverResponseForVersion<T>>
A CityResolverResponse.
- Defined in v1/core.ts:154

getHolidays

getHolidays(
options?: v20250101.HolidaysOptions,
): Promise<v20250101.HolidaysResponse>
"getHolidays" API (エンドポイント: /holidays) を呼び出します。

このAPIはバージョン管理されていません。
Parameters
- options: v20250101.HolidaysOptions = {}
  "getHolidays" API (エンドポイント: /holidays) を呼び出します。
  
  このAPIはバージョン管理されていません。
Returns Promise<v20250101.HolidaysResponse>
A HolidaysResponse.
- Defined in v1/core.ts:587

getNTACorporateInfo

getNTACorporateInfo<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    corporateNumber: string,
    apiVersion?: T,
): Promise<NTACorporateInfoResolverResponseForVersion<T>>
"getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- corporateNumber: string
  "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。
- OptionalapiVersion: T
  "getNTACorporateInfo" API (エンドポイント: /houjinbangou/{corporateNumber}) を呼び出します。
Returns Promise<NTACorporateInfoResolverResponseForVersion<T>>
An NTACorporateInfoResolverResponse.
- Defined in v1/core.ts:232

getNTAQualifiedInvoiceIssuerInfo

getNTAQualifiedInvoiceIssuerInfo<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    issuerNumber: string,
    apiVersion?: T,
): Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>
"getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- issuerNumber: string
  "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。
- OptionalapiVersion: T
  "getNTAQualifiedInvoiceIssuerInfo" API (エンドポイント: /invoice/{issuerNumber}) を呼び出します。
Returns Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>
An NTAQualifiedInvoiceIssuerInfoResolverResponse.
- Defined in v1/core.ts:315

getSchool

getSchool(schoolCode: string): Promise<v20250101.SchoolResolverResponse>
"getSchool" API (エンドポイント: /school/{schoolCode}) を呼び出します。

このAPIはバージョン管理されていません。
Parameters
- schoolCode: string
  "getSchool" API (エンドポイント: /school/{schoolCode}) を呼び出します。
  
  このAPIはバージョン管理されていません。
Returns Promise<v20250101.SchoolResolverResponse>
A SchoolResolverResponse.
- Defined in v1/core.ts:623

`Protected`request

request(endpoint: string, params?: {}, apiVersion?: string): Promise<unknown>
Parameters
- endpoint: string
- params: {} = {}
- OptionalapiVersion: string
Returns Promise<unknown>
- Defined in v1/core.ts:78

searchAddresses

searchAddresses<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    options: v20221101.AddressSearcherOptions,
    apiVersion?: T,
): Promise<AddressSearcherResponseForVersion<T>>
"searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- options: v20221101.AddressSearcherOptions
  "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。
- OptionalapiVersion: T
  "searchAddresses" API (エンドポイント: /postalcode/?...) を呼び出します。
Returns Promise<AddressSearcherResponseForVersion<T>>
An AddressSearcherResponse.
- Defined in v1/core.ts:186

searchBankBranches

searchBankBranches<T extends "2026-08-01" | undefined = undefined>(
    bankCode: string,
    options?: v20260801.BankBranchSearcherOptions,
    apiVersion?: T,
): Promise<BankBranchesResponseForVersion<T>>
Invokes "getBankBranches" API with a set of search parameters (endpoint: /bank/{bankCode}/branches?...).

Unlike getBankBranches, an empty result is not an error here: as long as q is given and the bank itself exists, the API responds with a 200 and an empty branches instead of a 404.

The search parameters were introduced in the 2026-08-01 API version; earlier versions ignore them and return every branch, which is why apiVersion cannot be an older one.
Type Parameters
- T extends "2026-08-01" | undefined = undefined
Parameters
- bankCode: string
  The bank code to query with.
- options: v20260801.BankBranchSearcherOptions = {}
  The query.
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BankBranchesResponseForVersion<T>>
A BankBranchesResponse.
- Defined in v1/core.ts:496

searchBanks

searchBanks<T extends "2026-08-01" | undefined = undefined>(
options?: v20260801.BankSearcherOptions,
apiVersion?: T,
): Promise<BanksResponseForVersion<T>>
Invokes "getBanks" API with a set of search parameters (endpoint: /bank?...).

Unlike getBanks, an empty result is not an error here: as long as q or type is given, the API responds with a 200 and an empty data instead of a 404.

The search parameters were introduced in the 2026-08-01 API version; earlier versions ignore them and return the whole set, which is why apiVersion cannot be an older one.
Type Parameters
- T extends "2026-08-01" | undefined = undefined
Parameters
- options: v20260801.BankSearcherOptions = {}
  The query.
- OptionalapiVersion: T
  The API version. The return type is determined based on this argument, and thus it cannot be a variable.
Returns Promise<BanksResponseForVersion<T>>
A BanksResponse.
- Defined in v1/core.ts:384

searchNTACorporateInfo

searchNTACorporateInfo<
    T extends
        | "2022-09-01"
        | "2022-11-01"
        | "2023-09-01"
        | "2024-01-01"
        | "2025-01-01"
        | "2026-08-01"
        | undefined = undefined,
>(
    options: v20221101.NTACorporateInfoSearcherOptions,
    apiVersion?: T,
): Promise<NTACorporateInfoSearcherResponseForVersion<T>>
"searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。
Type Parameters
- T extends
      | "2022-09-01"
      | "2022-11-01"
      | "2023-09-01"
      | "2024-01-01"
      | "2025-01-01"
      | "2026-08-01"
      | undefined = undefined
Parameters
- options: v20221101.NTACorporateInfoSearcherOptions
  "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。
- OptionalapiVersion: T
  "searchNTACorporateInfo" API (エンドポイント: /houjinbangou?...) を呼び出します。
Returns Promise<NTACorporateInfoSearcherResponseForVersion<T>>
An NTACorporateInfoSearcherResponse.
- Defined in v1/core.ts:263

searchSchool

searchSchool(
options: v20250101.SchoolSearcherOptions,
): Promise<v20250101.SchoolSearcherResponse>
"searchSchool" API (エンドポイント: /school/?...) を呼び出します。

このAPIはバージョン管理されていません。
Parameters
- options: v20250101.SchoolSearcherOptions
  "searchSchool" API (エンドポイント: /school/?...) を呼び出します。
  
  このAPIはバージョン管理されていません。
Returns Promise<v20250101.SchoolSearcherResponse>
A SchoolSearcherResponse.
- Defined in v1/core.ts:638

whoami

whoami(): Promise<v20250101.WhoamiResponse>
"whoami" API (エンドポイント: /whoami) を呼び出します。

このAPIはバージョン管理されていません。

Returns Promise<v20250101.WhoamiResponse>
A WhoamiResponse that contains the IP address the request was made from.
- Defined in v1/core.ts:573

Class KENALL

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns KENALL

Properties

Readonlyapibase

Readonlyapikey

Readonlytimeout

Methods

checkBusinessDay

Parameters

Returns Promise<v20250101.BusinessDayCheckResponse>

getAddress

Type Parameters

Parameters

Returns Promise<AddressResolverResponseForVersion<T>>

getBank

Type Parameters

Parameters

Returns Promise<BankResolverResponseForVersion<T>>

getBankBranch

Type Parameters

Parameters

Returns Promise<BankBranchResolverResponseForVersion<T>>

getBankBranches

Type Parameters

Parameters

Returns Promise<BankBranchesResponseForVersion<T>>

getBanks

Type Parameters

Parameters

Returns Promise<BanksResponseForVersion<T>>

getCities

Type Parameters

Parameters

Returns Promise<CityResolverResponseForVersion<T>>

getHolidays

Parameters

Returns Promise<v20250101.HolidaysResponse>

getNTACorporateInfo

Type Parameters

Parameters

Returns Promise<NTACorporateInfoResolverResponseForVersion<T>>

getNTAQualifiedInvoiceIssuerInfo

Type Parameters

Parameters

Returns Promise<NTAQualifiedInvoiceIssuerInfoResolverResponseForVersion<T>>

getSchool

Parameters

Returns Promise<v20250101.SchoolResolverResponse>

Protectedrequest

Parameters

Returns Promise<unknown>

searchAddresses

Type Parameters

Parameters

Returns Promise<AddressSearcherResponseForVersion<T>>

searchBankBranches

Type Parameters

Parameters

Returns Promise<BankBranchesResponseForVersion<T>>

searchBanks

Type Parameters

Parameters

Returns Promise<BanksResponseForVersion<T>>

searchNTACorporateInfo

Type Parameters

Parameters

Returns Promise<NTACorporateInfoSearcherResponseForVersion<T>>

searchSchool

Parameters

Returns Promise<v20250101.SchoolSearcherResponse>

whoami

Returns Promise<v20250101.WhoamiResponse>

Settings

`Readonly`apibase

`Readonly`apikey

`Readonly`timeout

`Protected`request