ファンダメンタルズ - Benzinga API Documentation

概要

利用可能な操作

getV21 - ファンダメンタルズ V2.1 を取得
getAlphaBeta - アルファ・ベータ V2.1 を取得
getCompanyV21 - 企業データ v2.1 を取得
getCompanyProfileV21 - 企業プロフィール v2.1 を取得
getShareClass - 株式クラス V2.1 を取得
getShareClassProfile - 株式クラスのプロフィール V2.1 を取得
get - ファンダメンタルズ V2 を取得
getAssetClassification - 資産分類 V2.1 を取得
getEarningsReports - 決算報告書 V2.1 を取得
getFinancialsV21 - 財務諸表 V2.1 を取得
getV3 - ファンダメンタルズ V3 を取得
getBalanceSheetV3 - バランスシート V3 を取得
getCashFlowV3 - キャッシュフロー V3 を取得
getIncomeStatement - 損益計算書 V3 を取得
getSharePriceRatios - 株価比率 V3 を取得

getV21

ファンダメンタルズ v2.1 の取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetFundamentalsV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetFundamentalsV21Response res = sdk.fundamentals().getV21()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理
        }
    }
}

パラメータ

パラメータ	型	必須	説明
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetFundamentalsV21Response

エラー

エラー種別	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getAlphaBeta

Alpha Beta の取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetAlphaBetaV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetAlphaBetaV21Response res = sdk.fundamentals().getAlphaBeta()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

パラメータ	型	必須	説明
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetAlphaBetaV21Response

エラー

エラータイプ	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getCompanyV21

企業データの取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetCompanyV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetCompanyV21Response res = sdk.fundamentals().getCompanyV21()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメーター

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	シンボルのカンマ区切りリスト
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetCompanyV21Response

エラー

エラー種別	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getCompanyProfileV21

企業プロフィールを取得します

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetCompanyProfileV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetCompanyProfileV21Response res = sdk.fundamentals().getCompanyProfileV21()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetCompanyProfileV21Response

エラー

エラータイプ	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getShareClass

株式クラスを取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetShareClassV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetShareClassV21Response res = sdk.fundamentals().getShareClass()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

パラメータ	型	必須	説明
`symbols`	String	:heavy_check_mark:	シンボルのカンマ区切り一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetShareClassV21Response

エラー

エラー種別	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getShareClassProfile

株式クラスのプロファイルを取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetShareClassProfileV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetShareClassProfileV21Response res = sdk.fundamentals().getShareClassProfile()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボルのリスト
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetShareClassProfileV21Response

エラー

エラータイプ	ステータスコード	Content-Type
models/errors/APIException	4XX, 5XX	/

get

Fundamentals v2 の取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetFundamentalsV2Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetFundamentalsV2Response res = sdk.fundamentals().get()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetFundamentalsV2Response

エラー

エラー種別	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getAssetClassification

資産分類の取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetAssetClassificationV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetAssetClassificationV21Response res = sdk.fundamentals().getAssetClassification()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメーター

パラメーター	型	必須	説明
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetAssetClassificationV21Response

エラー

エラー種別	ステータスコード	Content-Type
models/errors/APIException	4XX, 5XX	/

getEarningsReports

決算レポートを取得します

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetEarningsReportsV21Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetEarningsReportsV21Response res = sdk.fundamentals().getEarningsReports()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	シンボルのカンマ区切り一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetEarningsReportsV21Response

エラー

エラータイプ	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getFinancialsV21

Financials v2.1 を取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.errors.BzhttpResp;
import org.benzinga.BZClient.models.operations.GetFinancialsV21Response;

public class Application {

    public static void main(String[] args) throws BzhttpResp, Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetFinancialsV21Response res = sdk.fundamentals().getFinancialsV21()
                .symbols("<value>")
                .asOf("<value>")
                .period("<value>")
                .reportType("<value>")
                .call();

        if (res.strings().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボル一覧
`asOf`	Optional<String>	:heavy_minus_sign:	基準日
`period`	Optional<String>	:heavy_minus_sign:	会計期間
`reportType`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetFinancialsV21Response

エラー

エラー種別	ステータスコード	Content-Type
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

getV3

ファンダメンタルズ v3 を取得します

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetFundamentalsV3Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetFundamentalsV3Response res = sdk.fundamentals().getV3()
                .symbols("<value>")
                .from("<value>")
                .to("<value>")
                .date("2024-10-27")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

パラメータ名	型	必須	説明
`symbols`	String	:heavy_check_mark:	シンボルをカンマ区切りで指定
`from`	Optional<String>	:heavy_minus_sign:	開始日
`to`	Optional<String>	:heavy_minus_sign:	終了日
`date`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetFundamentalsV3Response

エラー

エラー種別	ステータスコード	Content-Type
models/errors/APIException	4XX, 5XX	/

getBalanceSheetV3

貸借対照表 v3 を取得する

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.errors.BzhttpResp;
import org.benzinga.BZClient.models.operations.GetBalanceSheetV3Response;

public class Application {

    public static void main(String[] args) throws BzhttpResp, Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetBalanceSheetV3Response res = sdk.fundamentals().getBalanceSheetV3()
                .symbols("<value>")
                .from("<value>")
                .to("<value>")
                .date("2023-12-25")
                .call();

        if (res.strings().isPresent()) {
            // レスポンスを処理する
        }
    }
}

Parameters

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	シンボル (カンマ区切りのシンボル一覧)
`from`	Optional<String>	:heavy_minus_sign:	開始日
`to`	Optional<String>	:heavy_minus_sign:	終了日
`date`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetBalanceSheetV3Response

エラー

エラー種別	ステータスコード	Content-Type
models/errors/BzhttpResp	400	application/json
models/errors/APIException	4XX, 5XX	/

getCashFlowV3

キャッシュフロー v3 を取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.errors.BzhttpResp;
import org.benzinga.BZClient.models.operations.GetCashFlowV3Response;

public class Application {

    public static void main(String[] args) throws BzhttpResp, Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetCashFlowV3Response res = sdk.fundamentals().getCashFlowV3()
                .symbols("<value>")
                .from("<value>")
                .to("<value>")
                .date("2024-05-15")
                .call();

        if (res.strings().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボルのリスト
`from`	Optional<String>	:heavy_minus_sign:	開始日
`to`	Optional<String>	:heavy_minus_sign:	終了日
`date`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetCashFlowV3Response

エラー

エラータイプ	ステータスコード	Content-Type
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

getIncomeStatement

損益計算書 v3 の取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.operations.GetIncomeStatementV3Response;

public class Application {

    public static void main(String[] args) throws Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetIncomeStatementV3Response res = sdk.fundamentals().getIncomeStatement()
                .symbols("<value>")
                .from("<value>")
                .to("<value>")
                .date("2023-12-17")
                .call();

        if (res.string().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	カンマ区切りのシンボルの一覧
`from`	Optional<String>	:heavy_minus_sign:	開始日
`to`	Optional<String>	:heavy_minus_sign:	終了日
`date`	Optional<String>	:heavy_minus_sign:	レポートタイプ

レスポンス

GetIncomeStatementV3Response

エラー

エラー種別	ステータスコード	コンテンツタイプ
models/errors/APIException	4XX, 5XX	/

getSharePriceRatios

株価指標を取得

使用例

package hello.world;

import java.lang.Exception;
import org.benzinga.BZClient.Bzclient;
import org.benzinga.BZClient.models.errors.BzhttpResp;
import org.benzinga.BZClient.models.operations.GetSharePriceRatiosV3Response;

public class Application {

    public static void main(String[] args) throws BzhttpResp, Exception {

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetSharePriceRatiosV3Response res = sdk.fundamentals().getSharePriceRatios()
                .symbols("<value>")
                .from("<value>")
                .to("<value>")
                .date("2024-06-28")
                .call();

        if (res.strings().isPresent()) {
            // レスポンスを処理する
        }
    }
}

パラメータ

Parameter	Type	Required	Description
`symbols`	String	:heavy_check_mark:	シンボルのカンマ区切りリスト
`from`	Optional<String>	:heavy_minus_sign:	開始日
`to`	Optional<String>	:heavy_minus_sign:	終了日
`date`	Optional<String>	:heavy_minus_sign:	レポート種別

レスポンス

GetSharePriceRatiosV3Response

エラー

エラー種別	ステータスコード	Content-Type
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

​概要

​利用可能な操作

​getV21

​使用例

​パラメータ

​レスポンス

​エラー

​getAlphaBeta

​使用例

​パラメータ

​レスポンス

​エラー

​getCompanyV21

​使用例

​パラメーター

​レスポンス

​エラー

​getCompanyProfileV21

​使用例

​パラメータ

​レスポンス

​エラー

​getShareClass

​使用例

​パラメータ

​レスポンス

​エラー

​getShareClassProfile

​使用例

​パラメータ

​レスポンス

​エラー

​get

​使用例

​パラメータ

​レスポンス

​エラー

​getAssetClassification

​使用例

​パラメーター

​レスポンス

​エラー

​getEarningsReports

​使用例

​パラメータ

​レスポンス

​エラー

​getFinancialsV21

​使用例

​パラメータ

​レスポンス

​エラー

​getV3

​使用例

​パラメータ

​レスポンス

​エラー

​getBalanceSheetV3

​使用例

​Parameters

​レスポンス

​エラー

​getCashFlowV3

​使用例

​パラメータ

​レスポンス

​エラー

​getIncomeStatement

​使用例

​パラメータ

​レスポンス

​エラー

​getSharePriceRatios

​使用例

​パラメータ

​レスポンス

​エラー

概要

利用可能な操作

getV21

使用例

パラメータ

レスポンス

エラー

getAlphaBeta

使用例

パラメータ

レスポンス

エラー

getCompanyV21

使用例

パラメーター

レスポンス

エラー

getCompanyProfileV21

使用例

パラメータ

レスポンス

エラー

getShareClass

使用例

パラメータ

レスポンス

エラー

getShareClassProfile

使用例

パラメータ

レスポンス

エラー

get

使用例

パラメータ

レスポンス

エラー

getAssetClassification

使用例

パラメーター

レスポンス

エラー

getEarningsReports

使用例

パラメータ

レスポンス

エラー

getFinancialsV21

使用例

パラメータ

レスポンス

エラー

getV3

使用例

パラメータ

レスポンス

エラー

getBalanceSheetV3

使用例

Parameters

レスポンス

エラー

getCashFlowV3

使用例

パラメータ

レスポンス

エラー

getIncomeStatement

使用例

パラメータ

レスポンス

エラー

getSharePriceRatios

使用例

パラメータ

レスポンス

エラー