ice

Create Intercontinental Exchange (ICE) connection

Since R2025a

expand all in page

    Description

    The ice function creates an object that represents a connection to the Intercontinental Exchange® (ICE®) data server. After you create an ice object, you can retrieve reference, pricing, sustainability, and physical risk data for use in your workflows.

    Creation

    Syntax

    c = ice(username,password)
    c = ice(username,password,timeout,url,mediatype,debugmodevalue)

    Description

    c = ice(username,password) creates a connection to the ICE data server that allows you to access reference, pricing, sustainability, and physical risk data.

    example

    c = ice(username,password,timeout,url,mediatype,debugmodevalue) additionally sets the timeout value, the ICE base endpoint URL, the REST API call media type, and the MATLAB® HTTP library debug value for the connection to the ICE data server.

    Input Arguments

    expand all

    Username for your ICE connection, specified as a string scalar or character vector. This argument sets the UserName property.

    Password, specified as a string scalar or character vector. This argument sets the Password property.

    Timeout value for ICE REST API call responses, specified as a positive numeric scalar. This argument sets the TimeOut property.

    ICE base endpoint URL, specified as a string scalar or character vector. This argument sets the URL property.

    REST API call media type, specified as a string scalar or character vector. This argument sets the MediaType property.

    MATLAB HTTP library debug mode, specified as 0, 1, or 2. The value of this argument controls the amount of diagnostic information returned.

    • 0 returns no diagnostic information.

    • 1 returns partial diagnostic information.

    • 2 returns complete diagnostic information.

    This argument sets the DebugModeValue property.

    Properties

    expand all

    Public

    Timeout value for ICE REST API call responses. This property is set by the timeout argument.

    Username for your ICE connection. This property is set by the username argument.

    Private

    ICE authentication token. This property is set by the username and password arguments.

    Password for your ICE connection. This property is set by the password argument.

    Hidden

    MATLAB HTTP library debug value. This property is set by the debugmodevalue argument.

    REST API call media type. This property is set by the mediatype argument.

    ICE base endpoint URL. This property is set by the url argument.

    Object Functions

    getDataIntercontinental Exchange (ICE) data request

    Examples

    collapse all

    Create an ice connection by specifying your username and password.

    username="usernameICE";
password="passwordICE";
c = ice(username,password)
    c =

     ice with properties: 

        TimeOut: 200.00
       UserName: "username"

    Version History

    Introduced in R2025a

    See Also