Fundamentos - Benzinga API Documentation

Descripción general

Operaciones disponibles

getV21 - Obtener Fundamentos V2.1
getAlphaBeta - Obtener Alfa Beta V2.1
getCompanyV21 - Obtener datos de la empresa v2.1
getCompanyProfileV21 - Obtener perfil de la empresa v2.1
getShareClass - Obtener clase de acciones V2.1
getShareClassProfile - Obtener perfil de la clase de acciones V2.1
get - Obtener Fundamentos V2
getAssetClassification - Obtener clasificación de activos V2.1
getEarningsReports - Obtener informes de resultados V2.1
getFinancialsV21 - Obtener estados financieros V2.1
getV3 - Obtener Fundamentos V3
getBalanceSheetV3 - Obtener balance general V3
getCashFlowV3 - Obtener flujos de efectivo V3
getIncomeStatement - Obtener estado de resultados V3
getSharePriceRatios - Obtener ratios del precio de la acción V3

getV21

Obtener fundamentos V2.1

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista separada por comas de símbolos
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de corte
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetFundamentalsV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getAlphaBeta

Obtener alfa y beta

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetAlphaBetaV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getCompanyV21

Obtener datos de la compañía

Ejemplo de uso

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()) {
            // gestionar respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetCompanyV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getCompanyProfileV21

Obtener el perfil de la empresa

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos, separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetCompanyProfileV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getShareClass

Obtener clase de acciones

Ejemplo de uso

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()) {
            // gestionar respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos, separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetShareClassV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getShareClassProfile

Obtener el perfil de la clase de acciones

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos, separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetShareClassProfileV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

get

Obtener fundamentos V2

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetFundamentalsV2Response

Errores

Tipo de error	Código de estado HTTP	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getAssetClassification

Obtener la clasificación de activos

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de corte
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de reporte

Respuesta

GetAssetClassificationV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getEarningsReports

Obtener informes de resultados

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separada por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetEarningsReportsV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getFinancialsV21

Obtener estados financieros v2.1

Ejemplo de uso

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()) {
            // gestionar respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`asOf`	Optional<String>	:heavy_minus_sign:	Fecha de referencia
`period`	Optional<String>	:heavy_minus_sign:	Período
`reportType`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetFinancialsV21Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

getV3

Obtener fundamentos v3

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`from`	Optional<String>	:heavy_minus_sign:	Fecha de inicio
`to`	Optional<String>	:heavy_minus_sign:	Fecha de fin
`date`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetFundamentalsV3Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getBalanceSheetV3

Obtener balance general v3

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parâmetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Símbolos (lista de símbolos separada por comas)
`from`	Optional<String>	:heavy_minus_sign:	Desde
`to`	Optional<String>	:heavy_minus_sign:	Hasta
`date`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetBalanceSheetV3Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/BzhttpResp	400	application/json
models/errors/APIException	4XX, 5XX	/

getCashFlowV3

Obtener flujo de caja v3

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`from`	Optional<String>	:heavy_minus_sign:	Fecha inicial
`to`	Optional<String>	:heavy_minus_sign:	Fecha final
`date`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetCashFlowV3Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

getIncomeStatement

Obtener el estado de resultados V3

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos, separados por comas
`from`	Optional<String>	:heavy_minus_sign:	Fecha de inicio
`to`	Optional<String>	:heavy_minus_sign:	Fecha de fin
`date`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetIncomeStatementV3Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/APIException	4XX, 5XX	/

getSharePriceRatios

Obtener ratios del precio de la acción

Ejemplo de uso

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()) {
            // manejar la respuesta
        }
    }
}

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`symbols`	String	:heavy_check_mark:	Lista de símbolos separados por comas
`from`	Optional<String>	:heavy_minus_sign:	Fecha de inicio
`to`	Optional<String>	:heavy_minus_sign:	Fecha de fin
`date`	Optional<String>	:heavy_minus_sign:	Tipo de informe

Respuesta

GetSharePriceRatiosV3Response

Errores

Tipo de error	Código de estado	Tipo de contenido
models/errors/BzhttpResp	400, 500	application/json
models/errors/APIException	4XX, 5XX	/

Introduction

Services

​Descripción general

​Operaciones disponibles

​getV21

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getAlphaBeta

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getCompanyV21

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getCompanyProfileV21

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getShareClass

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getShareClassProfile

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​get

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getAssetClassification

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getEarningsReports

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getFinancialsV21

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getV3

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getBalanceSheetV3

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getCashFlowV3

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getIncomeStatement

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

​getSharePriceRatios

​Ejemplo de uso

​Parámetros

​Respuesta

​Errores

Descripción general

Operaciones disponibles

getV21

Ejemplo de uso

Parámetros

Respuesta

Errores

getAlphaBeta

Ejemplo de uso

Parámetros

Respuesta

Errores

getCompanyV21

Ejemplo de uso

Parámetros

Respuesta

Errores

getCompanyProfileV21

Ejemplo de uso

Parámetros

Respuesta

Errores

getShareClass

Ejemplo de uso

Parámetros

Respuesta

Errores

getShareClassProfile

Ejemplo de uso

Parámetros

Respuesta

Errores

get

Ejemplo de uso

Parámetros

Respuesta

Errores

getAssetClassification

Ejemplo de uso

Parámetros

Respuesta

Errores

getEarningsReports

Ejemplo de uso

Parámetros

Respuesta

Errores

getFinancialsV21

Ejemplo de uso

Parámetros

Respuesta

Errores

getV3

Ejemplo de uso

Parámetros

Respuesta

Errores

getBalanceSheetV3

Ejemplo de uso

Parámetros

Respuesta

Errores

getCashFlowV3

Ejemplo de uso

Parámetros

Respuesta

Errores

getIncomeStatement

Ejemplo de uso

Parámetros

Respuesta

Errores

getSharePriceRatios

Ejemplo de uso

Parámetros

Respuesta

Errores