getFieldLists

Retrieve Bloomberg Hypermedia field list information

Since R2023b

Syntax

[fieldLists,response] = getFieldLists(c,userCatalog)

[fieldLists,response] = getFieldLists(c,userCatalog,fieldListID)

Description

[fieldLists,response] = getFieldLists(c,userCatalog) retrieves Bloomberg^® Hypermedia field list information for all available field lists, where c is the Bloomberg Hypermedia connection object and userCatalog is your catalog ID from Bloomberg.

[fieldLists,response] = getFieldLists(c,userCatalog,fieldListID) retrieves Bloomberg Hypermedia field list information for a specified field list contained in fieldListID.

Examples

Retrieve Bloomberg Hypermedia Information for Field Lists

Retrieve information about all available field lists or a given field list using the getFieldLists function.

Create a Bloomberg Hypermedia connection object by using the API key provided by Bloomberg.

credentialsString = '{"client_id":"89beaeab724bbdf5e186b733c58af2","client_secret":"77050429aee81eb31793fb10fa4301c54911db545de8b2990252ffe2b56b11","name":"BloombergHAIDevelopment","scopes":["eap","beapData","reportingapi"],"expiration_date":1699198358934,"created_date":1651764758934}'
c = bloombergHypermedia(credentialsString)

c = 
 
  bloombergHypermedia with properties:

      TimeOut: 200.00

Use the getFieldLists function. Replace "123" with your login credentials for the catalog you want to access.

userCatalog = "123";
[fieldLists,response] = getFieldLists(c,userCatalog)

fieldLists =

  20×7 table

                            x_id                                 x_type                              description                                            identifier                                     issued                            modified                                               title                               
    ____________________________________________________    _________________    ___________________________________________________    ___________________________________________________    _______________________________    _______________________________    ___________________________________________________________________


    {'fieldList202303201129504b4a22/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList202303201129504b4a22'                  }    {'2023-03-20T15:29:51.042438Z'}    {'2023-03-20T15:29:51.042438Z'}    {'Test Data Field List 20-Mar-2023 11:29:50'                      }
    {'fieldList202303201120116ae9bd/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList202303201120116ae9bd'                  }    {'2023-03-20T15:20:11.661984Z'}    {'2023-03-20T15:20:11.661984Z'}    {'Test Data Field List 20-Mar-2023 11:20:11'                      }
    {'fieldList202303201117415fd868/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList202303201117415fd868'                  }    {'2023-03-20T15:17:41.950295Z'}    {'2023-03-20T15:17:41.950295Z'}    {'Test Data Field List 20-Mar-2023 11:17:41'                      }
    {'fieldList20230320111658be00c2/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230320111658be00c2'                  }    {'2023-03-20T15:16:58.703170Z'}    {'2023-03-20T15:16:58.703170Z'}    {'Test Data Field List 20-Mar-2023 11:16:58'                      }
    {'fieldList20230124092443a3974f/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230124092443a3974f'                  }    {'2023-01-24T14:24:44.260415Z'}    {'2023-01-24T14:24:44.260415Z'}    {'Test Data Field List 24-Jan-2023 09:24:43'                      }
    {'fieldList20230120144820332a94/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230120144820332a94'                  }    {'2023-01-20T19:48:20.641400Z'}    {'2023-01-20T19:48:20.641400Z'}    {'Test Data Field List 20-Jan-2023 14:48:20'                      }
    {'fieldList20230120144718d4781f/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230120144718d4781f'                  }    {'2023-01-20T19:47:18.627445Z'}    {'2023-01-20T19:47:18.627445Z'}    {'Test Data Field List 20-Jan-2023 14:47:18'                      }
    {'fieldList20230120144632f6f536/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230120144632f6f536'                  }    {'2023-01-20T19:46:33.237643Z'}    {'2023-01-20T19:46:33.237643Z'}    {'Test Data Field List 20-Jan-2023 14:46:32'                      }
    {'fieldListWithDatesInRequest202301191108005212e8/'}    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldListWithDatesInRequest202301191108005212e8'}    {'2023-01-19T16:17:26.823131Z'}    {'2023-01-19T16:17:26.823131Z'}    {'Test Data Field List with Dates in Request 19-Jan-2023 11:06:19'}
    {'fieldList2023010610540675816b/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList2023010610540675816b'                  }    {'2023-01-06T15:54:06.489089Z'}    {'2023-01-06T15:54:06.489089Z'}    {'Test Data Field List 06-Jan-2023 10:54:06'                      }
    {'fieldList20230106095625b6dd54/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230106095625b6dd54'                  }    {'2023-01-06T14:56:25.679940Z'}    {'2023-01-06T14:56:25.679940Z'}    {'Test Data Field List 06-Jan-2023 09:56:25'                      }
    {'fieldList20230105133953900e3c/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230105133953900e3c'                  }    {'2023-01-05T18:39:53.850982Z'}    {'2023-01-05T18:39:53.850982Z'}    {'Test Data Field List 05-Jan-2023 13:39:53'                      }
    {'fieldList202301051337540ebd67/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList202301051337540ebd67'                  }    {'2023-01-05T18:37:54.714813Z'}    {'2023-01-05T18:37:54.714813Z'}    {'Test Data Field List 05-Jan-2023 13:37:54'                      }
    {'fieldList2023010415301547ef3f/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList2023010415301547ef3f'                  }    {'2023-01-04T20:30:16.393986Z'}    {'2023-01-04T20:30:16.393986Z'}    {'Test Data Field List 04-Jan-2023 15:30:15'                      }
    {'fieldList20230104152346ae0469/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230104152346ae0469'                  }    {'2023-01-04T20:23:46.654902Z'}    {'2023-01-04T20:23:46.654902Z'}    {'Test Data Field List 04-Jan-2023 15:23:46'                      }
    {'fieldList20230104145204519567/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230104145204519567'                  }    {'2023-01-04T19:52:05.241419Z'}    {'2023-01-04T19:52:05.241419Z'}    {'Test Data Field List 04-Jan-2023 14:52:04'                      }
    {'fieldList202301031310579724ac/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList202301031310579724ac'                  }    {'2023-01-03T18:10:57.766595Z'}    {'2023-01-03T18:10:57.766595Z'}    {'Test Data Field List 03-Jan-2023 13:10:57'                      }
    {'fieldList20230103130913d728ae/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230103130913d728ae'                  }    {'2023-01-03T18:09:13.700894Z'}    {'2023-01-03T18:09:13.700894Z'}    {'Test Data Field List 03-Jan-2023 13:09:13'                      }
    {'fieldList2023010312582323f0a4/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList2023010312582323f0a4'                  }    {'2023-01-03T17:58:23.595193Z'}    {'2023-01-03T17:58:23.595193Z'}    {'Test Data Field List 03-Jan-2023 12:58:23'                      }
    {'fieldList20230103124332ed04b9/'                  }    {'DataFieldList'}    {'Test data field list: pxAsk, pxLast, idBbGlobal'}    {'fieldList20230103124332ed04b9'                  }    {'2023-01-03T17:43:33.419811Z'}    {'2023-01-03T17:43:33.419811Z'}    {'Test Data Field List 03-Jan-2023 12:43:32'                      }


response = 

  ResponseMessage with properties:

    StatusLine: 'HTTP/1.1 303 SEE OTHER'
    StatusCode: SeeOther
        Header: [1×15 matlab.net.http.HeaderField]
          Body: [1×1 matlab.net.http.MessageBody]
     Completed: 0

 
    

You can also retrieve information about a given field list by specifying the field list ID as the third input argument.

fieldListID = "fieldList20220524132236008066";
fieldList = getFieldLists(c,userCatalog,fieldListID)

fieldList =
  
    3x8 table
  
                                    x_id                                    cleanName       dlCommercialModelCategory      identifier      loadingSpeed        mnemonic                              title                              type     
      ________________________________________________________________    ______________    _________________________    ______________    ____________    ________________    _________________________________________________    _____________
  
      {'https://api.bloomberg.com/eap/catalogs/bbg/fields/pxAsk'     }    {'pxAsk'     }     {'Pricing - Intraday'}      {'pxAsk'     }      {'Hare'}      {'PX_ASK'      }    {'Ask Price'                                    }    {'Price'    }
      {'https://api.bloomberg.com/eap/catalogs/bbg/fields/pxLast'    }    {'pxLast'    }     {'Pricing - Intraday'}      {'pxLast'    }      {'Hare'}      {'PX_LAST'     }    {'Last Price'                                   }    {'Price'    }
      {'https://api.bloomberg.com/eap/catalogs/bbg/fields/idBbGlobal'}    {'idBbGlobal'}     {'Open Source'       }      {'idBbGlobal'}      {'Hare'}      {'ID_BB_GLOBAL'}    {'Financial Instrument Global Identifier (FIGI)'}    {'Character'}

Input Arguments

c — Bloomberg Hypermedia connection

Bloomberg Hypermedia object

Bloomberg Hypermedia connection, specified as a Bloomberg Hypermedia object.

userCatalog — User catalog identifier

string scalar | character vector

User catalog identifier, specified as a character vector or string scalar.

fieldListID — Field list identifier

string scalar | character vector

Field list identifier, specified as a character vector or string scalar.

Output Arguments

fieldLists — List of available fields or information about a requested field list

table

List of available fields or information about a requested field list, returned as a table.

response — HTTP request response

ResponseMessage object

HTTP request response, returned as a ResponseMessage object. For details, see matlab.net.http.ResponseMessage.

Version History

Introduced in R2023b