0% found this document useful (0 votes)

11 views

Bloomberg Developer - Data License - documentation

The Bloomberg Data License (DL) Platform enables users to request financial data for specified securities through methods like SFTP or SOAP API. Users must configure their SFTP access, manage certificates, and adhere to best practices for data requests to ensure efficient processing. The document outlines technical requirements, connection methods, and guidelines for optimal use of the platform.

Uploaded by

georgelucian3313

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

11 views

Bloomberg Developer - Data License - documentation

Uploaded by

georgelucian3313

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 124

Developer

Home Quick Starts Products Tutorials APIs Downloads

Home Products Data License

Data License

Documentation API Reference Downloads

Request Help
Overview
The Bloomberg Data License (DL) Platform allows you to request financial information by specifying a range of securities and a range of informatio

You can submit your DL Per Security request to the DL Platform through a variety of methods, including SFTP or SOAP API (Web Services).

Bloomberg processes these requests and sends a response containing the requested data values. This is a very flexible, effective, and timely way t

High Level Sequence Diagram

SFTP

SFTP via Internet

With SFTP via the Internet, there is no equipment charge or communication charge for Internet delivery and no need for additional payload/conte

Note: Bloomberg discourages use of the legacy DES software encryption option. If you are still using DES encryption, you can contact Bloomberg
You must open the following TCP port: Port 22

SFTP Internet access will be disabled after 180 days of inactivity. If your account becomes disabled, contact Customer Support to enable it again.

SFTP via Dedicated Circuit

Bloomberg DL is not hardware-dependent. If you want to use a dedicated circuit, you are responsible for all costs of communication, common car

There is an installation fee and a monthly equipment charge for the maintenance of hardware.

Setup for SFTP

A home directory is created on two interchangeable SFTP servers.

A Login and Password is assigned for the home directories.

The IP Addresses and Host Names of the SFTP servers are provided. For more: IP Addresses.

For SFTP via dedicated circuit, you must purchase communication equipment from Bloomberg. It must be installed by Bloomberg.

To use Data License (DL) Front End Software applications (e.g., Request Builder), contact your Bloomberg Sales Representative. Upon receip

Deleting Files
To provide a backup, by default, Bloomberg stores your files on two back-up servers. As a result, you may see a file you attempted to delete again

If you would like your files to be deleted permanently instead, please contact Customer Support.

IP Addresses
Internet Connections
For all account regions:

DNS | IPs
------------------------------|-------------------
sftp.bloomberg.com | 205.216.112.23 & 208.22.57.176

Note: Any one server machine may be down for regular maintenance. For contingency reasons, you are advised to use DNS sftp.bloomberg.com

Dedicated Line SFTP Connections

Account Region

NY and TO

Any one physical server machine may be down for regular maintenance. If you are connecting via Dedicated Lines, you should connect to the virtu

Clients/Users Requirements
You must provide Bloomberg with all the IPs you will be using to connect to Bloomberg’s SFTP servers. Without these stored on the account, your

You can add up to 5 IP addresses or address ranges to the security IP allowlist for Password access.

If you need more than 5 IP addresses or addresses ranges (e.g. in case of dynamic IP addresses), then you must provide Bloomberg with the publ

Public Key Format: OPENSSH, single-line format

Key Type: SSH-RSA

Strength: Minimum length of 2048 characters with a recommendation of 4096

Support for Multiple Keys

It is possible to add more than one public key to access the same account over SFTP. To do so, you must provide Bloomberg with the public key p

You have multiple SFTP accounts, you cannot use the same SSH key across all the accounts. Separate SSH keys must be used for different accounts

Legacy IP Addresses
Legacy IP addresses are being deprecated and removed. You must use supported IP addresses.

Web Services
Web Services (SOAP API) provides a programmatic interface to submit and retrieve messages to and from Bloomberg servers. Bloomberg provide

Web Services is available over the Internet only.

Text

## WSDL:
https://service.bloomberg.com/assets/dl/dlws.wsdl

## Service endpoint:
https://dlws.bloomberg.com/dlps

## IP Addresses:
69.191.229.90
69.191.193.90

Web Services Sample Code

To assist in initial development, Bloomberg provides sample code (Java and C#) as a reference, which you can enhance/optimize to meet your pro

The sample code can be downloaded from DLWS Samples. An SSL certificate and password will be provided by Bloomberg.

Supported Platforms
Web Services supports the following:

DLWS Certificate Manager

The Data License Web Services (DLWS) Certificate Manager is a self-service tool that lets you create your own certificates.

You can access this tool from:

Bloomberg DATA<GO>, by selecting User Name > Manage DLWS Connectivity from the header.

Enterprise Console, by selecting Configure > DLWS Certificate Manager.

Both links open a page on the Enterprise Console where you can see your list of certificates against each of your DL accounts that are enabled for

Managing DLWS Certificates

The dashboard lists all the DLWS accounts you are privileged to view and manage the certificates for. You can search a connectivity object by a DL

In the Connection Details page, there are three different tabs – Active Certificates, Expired Certificates, and Revoked Certificates.
Adding a New Certificate
The ADD NEW CERTIFICATE button is enabled only for users with the right permission. You can raise a ticket with Customer Support if the button

Click the ADD NEW CERTIFICATE button to move to the add certificate page.
Step 1: Obtain a Certificate Signing Request (CSR)
To generate a Certificate Signing Request (CSR), follow the steps under “How do I generate a CSR and private key?” in this link.

Or, you can generate a CSR using OpenSSL using the following command.

openssl req -new -newkey rsa:2048 -nodes -out <name_of_csr_file> -keyout <name_of_key_file>

Enter the following CSR details when prompted:

Common Name (CN): the fully qualified domain name

Organization Name (O): the full legal name of company

Organization Unit (OU): the full name of department

Locality Name (L): the locality or city name

State or Province Name (S): the full name of the state or province

Country Name (C): the official two letter country code

Email Address (E): email address

Alternatively, a subject can be added using -subj option in OpenSSL. However the string of the subject will not allow spaces or special characters,

openssl req -new -newkey rsa:2048 -nodes -out <name_of_csr_file> -keyout <name_of_key_file> -subj “/CN=<account_number>:D

Example:

openssl req -new -newkey rsa:2048 -nodes -out 123456.csr -keyout 123456.key -subj “/CN=123456:DLWS/O=Bloomberg./OU=DataLi

You will be able to find the full list of Distinguished Name (DN) on https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_7.5.0/com.ibm.mq

Other fields not listed above in the example can be passed into the CSR, but they will not be stored into the Creg database.

Step 2: Verify CSR Content

Make sure all fields meet the following requirements:

The maximum length of values of all fields should be 64 characters.

Common Name (CN): Required. “:DLWS” (e.g. 790223:DLWS)

Organization Name (O): alphanumeric + special characters & _ ‘ ( ) + , – . / ^ ~ < > = (e.g. Bloomberg L.P.)

Organization Unit (OU): alphanumeric + underscore (e.g. DataLicense)

Locality Name (L): alphanumeric + underscore (e.g. NEW YORK)

State or Province Name (S): alphanumeric + underscore (e.g. NY)

Country Name (C): alphanumeric + underscore

Email Address (E): prefix: alphanumeric + special characters _ . + – , domain: alphanumeric + special characters – .

Example:

Common Name = 123456:DLWS

Organization Name = Bloomberg L.P.

Organization Unit = DataLicense

Locality Name = NEW YORK

State or Province Name = NY

Country Name = US
Email Address = [email protected]

Step 3: Enter CSR

Once you have completed generating the CSR, copy the string of the csr file generated from Step 1 and paste it into the text input box.

Check the status of the validation of the format located right below the text box. Make sure the CSR string starts with “—–BEGIN CERTIFICATE REQ

If it is a valid format, you will see the green text, “CSR format is valid”. Otherwise, the warning message will appear with disabled GENERATE & DO
Step 4: Download Certificate
Click the GENERATE & DOWNLOAD button to download the certificate in your browser window.
Click the DONE button.

Make sure the certificate has been generated with 18 months (540 days) of expiry in the Active Certificate tab.

Step 5: Generate the PKCS12 Certificate (optional)

If you need the certificate in PKCS12 format, you can generate it using the PEM downloaded in Step 4 through the following command.

Enter a password to export when prompted and please remember the password for the future use in SoapUI.

openssl pkcs12 -export -out <name_of_pkcs12_file> -in <name_of_certificate_file> -inkey <name_of_private_key_file>

Example: openssl pkcs12 -export -out cert.p12 -in bbg-cert-790223.pem -inkey 790223.key

cert.p12 is the new PKCS12 certificate generated by this command, which can be used with DLWS

bbg-cert-790223.pem is the certificate downloaded from Step 4

790223.key is your private key generated from Step 1

PKCS12 vs PEM
The existing process generates what is known as a PKCS12 certificate. However, this is inherently insecure as Bloomberg must store the your privat

The new system on Enterprise Console/Bloomberg DATA<GO> uses industry standards for certificate generation. In the new workflow, you genera

Through the new process, your private key is not transmitted over the internet and should stay secure with you. The cert you receive through self-s

You can use the PEM certificate as-is or generate a replacement PKCS12 certificate if needed. You should retain a copy of your existing certificate, a

You should run the following command on your datacenter to generate the PKCS12 certificate using the PEM certificate generated using the Enter

openssl pkcs12 -export -out <name_of_pkcs12_file> -in <name_of_certificate_file> -inkey <name_of_private_key_file>

Example: openssl pkcs12 -export -out cert.p12 -in bbg-cert-123456.pem -inkey 123456.key

cert.p12 is the new PKCS12 certificate generated by this command, which can be used with DLWS

bbg-cert-123456.pem is the certificate provided by the new Enterprise Console/DATA<GO>

123456.key is your private key that you used to generate the CSR

Bloomberg Identifiers

ID_BB_GLOBAL
You can use the Bloomberg Global ID (ID_BB_GLOBAL) as a key field to link or join securities across files. It is a 12 digit alpha-numeric, randomly-ge

The BBGID:

Is allocated once the security is added to the system.

Is never reused and remains with the security (in perpetuity).

Does not change as a result of any corporate action.

Is stored in field ID135 ID_BB_GLOBAL. In addition, for Equity securities (excluding Equity Options), the Composite/Security Level BBGID is st

Should be used to track a change to a security’s CUSIP identifier, since such an action occurs often, especially for Collateralized Mortgage O

ID_BB_UNIQUE
You can use the Bloomberg Unique ID (ID_BB_UNIQUE) as a key field to link or join securities across requests. It is a unique, automatically-generate

An exception to this is for Equity Options, where the Unique ID is derived from other security-level data.

ID_BB_UNIQUE is unique to a specific security and not the company. If there is more than one ticker for a company within a country, each wil

ID_BB_UNIQUE may be used to track a change to a security’s CUSIP identifier, since such an action occurs often, especially for Collateralized

The combination of ID_BB_UNIQUE and ID_BB_COMPANY should be used to identify an individual security for Mortgages, Munis, and Indices.

ID_BB_COMPANY
You can use the Bloomberg Company ID (ID_BB_COMPANY ) to link or join securities of the same company across requests.

The combination of ID_BB_COMPANY and ID_BB_SECURITY identifies an individual security for Munis, Equities, Corporates, Governments, an

The combination of ID_BB_COMPANY and ID_BB_UNIQUE identifies an individual security for Munis, Mortgages, and Indices.

ID_BB_SECURITY
You should use the Bloomberg Security ID (ID_BB_SECURITY) in combination with ID_BB_COMPANY to distinguish between securities of the same co

By using these identifiers, you can link all securities with the same issuer or company name whether they are equity or debt instruments.

Best Practices
Data License (DL) Per Security allows you to request financial information for a specific portfolio of securities or companies.

This is a very flexible way for you to request data on an on-demand or on a scheduled basis and pay for only what you need. Data requests can be

Use of SFTP Directories Uploads

The use of file uploading associated with a DL Account is limited to creating Per Security requests. Any non-related files will be removed at Bloomb

Time and Date

When scheduling files, the TIME and RUNDATE headers should be used to set a specific time and date.

Scheduled files without the TIME header will default to run at midnight; heavy load at this time may cause response delays.

Large Historic Requests

Requests for large amounts of historical data will take longer to process. Instead of requesting the same historical data repeatedly to capture any c

Cash Dividends DVD_CASH

Stock Dividends DVD_STOCK

Stock Splits STOCK_SPLT

Rights Offerings RIGHTS_OFFER

Spin-offs SPIN

You are advised to avoid requesting a large amount of history during peak times of day, e.g. around market open or close time.

Request Submission Frequency

You should limit your requests so that no more than 10 requests are submitted per minute.

Polling
Bloomberg recommends using appropriate polling intervals for retrieving responses from SFTP and Web Services.

You should create a baseline for your responses:

If a typical request takes 30 seconds, then 30 seconds should be used as the baseline for polling responses.

If a larger request (e.g., a request for more securities, history, or derived fields) usually takes two minutes, then two minutes should be the b

Bloomberg recommends an interval of at least 30 seconds.

Small Requests
Small requests are inefficient. DL throttles requests to ensure that individual accounts do not consume more than an allocated amount of system re

You can achieve better performance by grouping securities into larger requests, which results in reduced throttling and overhead in processing ad

Keep in mind that for Web Services, this needs to be tempered against generating large XML response files.

Scheduling Times
Running requests outside of the busier times of day will yield better performance.

Busy times of day include market open and close for each region. Additionally, there is typically a surge of requests at the top of the hour. Request

Monthly Maintenance
Historical Data products charge Monthly Unique Security rates for the first month and then the lower Monthly Maintenance rates for subsequent m

If a month is skipped, the Monthly Unique Security rate will apply again when the request resumes. You should take this cost implication into consi

Corporate Action Notification Service (CANS)

For timely receipt of corporate actions data, the Corporate Action Notification Service (CANS) product is more efficient than the Per Security getAc

CANS is an event-based product that pushes data out to you after it is entered into the Bloomberg system. Repeated requests to poll for actions v

File Names
Bloomberg recommends that you use different file names for different requests, especially if running multiple requests on the same day.

When retrieving a response file, you should ensure that the output file being retrieved matches the corresponding request file, including the date

Allowed Characters
For:

SFTP File Names

REPLYFILENAME Header

Whitespace is not allowed. Please use only the following allowed characters (up to 25):

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
a b c d e f g h i j k l m n o p q r s t u v w x y z
1 2 3 4 5 6 7 8 9 0
_ . -

Beta
In general, the VERSION=NEW header should not be used. It hits a beta version of Bloomberg software that is less reliable than the production versio

Unused SFTP sessions

Do not keep unused SFTP sessions open for an extended period. If too many SFTP sessions are opened simultaneously, additional connection atte

WSDL
The WSDL is an API to Data License Web Services (DLWS).

A typical use case is to generate the code one time using the WSDL. This should not be used as part of the daily workflow.

In the event the WSDL content changes, proper notice will be sent through Bloomberg’s notification service. You are advised to not programmatic

450 Field Limit per Request

Since requests may include up to 50 extra internal Bloomberg Fields for billing or validation, do not request more than 450 Fields. A total of more

Limitations

Entity Limit

All Requests

Securities For getData requests in Scheduled Mode: 200,000 securities per request.
For getHistory requests that include one or more fundamental/industry-specific fields: 1000 s
For all other requests and modes (i.e., Adhoc Mode and Scheduled Mode): 20,000 securities

Field Overrides 19 overrides per security. For more: getData > Overrides.

Fields 450 fields per request. For more: Request Composition > List of Fields.

NOTE

Do not request more than 450 fields because requests may include up to 50 extra intern

64 characters per DLWS Certificate Signing Request (CSR) field value. For more: Managing D

Security IDs For <Identifier> and <Security Identifier>: 32 characters.

For <Market Sector>: 6 characters.
For more: Securities.

getHistory Requests For requests that include one or more fundamental field:
For more: getHistory
10 years of historical data.

1000 securities.

100 fundamental/industry-specific fields

NOTE

If you request more than 450 total fields, the response includes all fundamental/

For horizontal format requests: 60,000,000 data points.

For vertical format requests: 30,000,000 data points

getActions Requests DATERANGE: No more than 7 days prior to request date.

For more: getActions

getTickHistory Requests
For more: getTickHistory

1 year per request

DATETIMERANGE

Start Date 20080101 or later

Response File Size 2 GB (20 GB uncompressed). For more: Excessive size error.

GSAC Bond Pricing Sources BGN, CBBT, TRAC, or Bloomberg’s MTF

US Option Availability Last 6 weeks

getQuotes and getAllQuotes Requests

For more: getQuotes and getAllQuotes

3 consecutive days per request

DATERANGE

Start Date Maximum of 240 trading days before the current day or the number of days when the securit

Individual Ticks Per Response 20 million

NOTE

If you exceed this limit, the response truncates at the previous full record and returns co

Rate Limiting

Requests 10 requests per minute

Concurrent Connections 250 connections

Characters

Response file name Cannot include white spaces or any of the following: ` ~ ! @ # $ % & * ( ) [ ] , { } : ; ‘ ” > < / ? | =
For more: Response Charset.
Request Composition

Request Charset
The request file name can be any string not exceeding 25 characters, including the .req extension. It may not begin with the – or . character and

\t ` ~ ! @ # $ % & * ( ) [ ] { } ; ' " < > / ? |

Additionally, the colon (:), backslash (\), forward slash (/), and single quote (') characters are not allowed for SFTP requests.

Request Format
Requests must be composed of printable ASCII characters only; no binary characters or special escape sequences are allowed.

Requests formatted as DOS files, which contain an additional carriage return as the end-of-line marker, are accepted.

Requests in other formats (e.g. – Word, Excel) are not accepted. The default delimiter character used in requests is Unix pipe “|”.

Requests must follow this format:

Section

START-OF-FILE

Request Header

List of Fields

List of Securities

END-OF-FILE

Note: The order of tags and sections in requests always correspond to the table above.

START-OF-FILE: This tag defines the beginning of a request.

Request Header: This section contains information that identifies the customer, the type of request to run, the time to run the request, and o

List of Fields: This section may or may not be needed in a request, depending upon the program you are running (i.e., data items must be s

List of Securities: This section can be filled with a list of individual securities.

END-OF-FILE: This record defines the end of the Per Security request file. It must be the last record in the request. If it is not in the request, t

Note: Reply files have similar structure that is described in Response Data, and can contain error descriptions as commented text before START-OF

Blank lines may appear freely within a request and are always be ignored, regardless of their position within the request after START-OF-FILE. Line

List of Fields
The list of fields is used to specify the fields that will be retrieved in response to the Per Security request.

NOTE

For programmatic access to all Data License (DL) fields, download the Fields dataset.
The weekly Fields.csv and fields.ttl files contain the metadata for fields that the DL product delivers. annotationsMetaModel.ttl includes metadata for the
The files appear in the root directory and contain more than 14,000 fields, each of which has corresponding metadata as an entry within fields .csv / .ttl. Me

Text

## Fields must be listed between the following two declarations

START-OF-FIELDS
<Field Mnemonics>
END-OF-FIELDS

## The list of fields must be after the header and before the list of securities. A maximum of 500 fields can be

START-OF-FIELDS
ID_ISIN
NAME
PX_ASK
MTG_WAC
EQY_BETA
YLD_CNV_ASK
END-OF-FIELDS

## The way in which field information is returned may be specified (all arguments are optional and separated by t

<field mnemonic>| <field width> | <decimal places> | <FP format>

Any field specification can have the following optional parameters:

Argument Description

field width Sets the size (number of characters) of the field that is returned.
If a value is not specified, the defaults are as follows: if the OUTPUTFORMAT is specified as variable (the default), the r
If the OUTPUTFORMAT parameter is equal to fixed, the size of the field defaults to a predetermined fixed size for that fi

decimal places Sets the number of decimal places that are returned with Price fields.
For character and Real fields, this value is ignored.
If this option is not specified, the number of decimal places will vary according to field.
Columns in the fields.csv dataset provide information about each field’s decimal places.

For more examples on field width and decimal places usage: Sample Files for Customizing Output Format.

Sample Files for Customizing Output Format

## Request File 1
## This sample shows using different field formatting.
## This shows usage of 'field width', 'decimal places', 'SECDESLENGTH' parameters.
## Note that 'field width' is set to 14 in the following lines: 'PX_LAST|14' & 'PX_LAST|14|4'
## Note that 'decimal places' is set to 4 and 8 in the following lines: 'PX_LAST|14|4' & 'PX_LAST||8'

START-OF-FILE
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_fields.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=variable
SECDESLENGTH=14
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST|14
PX_LAST|14|4
PX_LAST||8
END-OF-FIELDS
START-OF-DATA
IBM US Equity||
END-OF-DATA
END-OF-FILE

## Reply File 1

START-OF-FILE
RUNDATE=20180515
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_fields.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=variable
SECDESLENGTH=14
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST|14
PX_LAST|14|4
PX_LAST||8
END-OF-FIELDS
TIMESTARTED=Tue May 15 13:20:54 EDT 2018
START-OF-DATA
IBM US Equity |0|6|INTL BUSINESS MACHINES CORP|INTL BUSINESS MA|143.470000|143.470000 |143.4700 |143.47000000|
END-OF-DATA
TIMEFINISHED=Tue May 15 13:21:11 EDT 2018
END-OF-FILE

## Request File 2
## This sample shows using custom field values delimieter: 'DELIMITER=;'
## The rest of parameters are equal to the previous sampe.

START-OF-FILE
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_delimiter.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=variable
SECDESLENGTH=14
DELIMITER=;
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST|14
PX_LAST||8
END-OF-FIELDS
START-OF-DATA
IBM US Equity||
END-OF-DATA
END-OF-FILE

## Reply File 2

START-OF-FILE
RUNDATE=20180515
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_delimiter.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=variable
SECDESLENGTH=14
DELIMITER=;
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST|14
PX_LAST||8
END-OF-FIELDS
TIMESTARTED=Tue May 15 12:44:19 EDT 2018
START-OF-DATA
"IBM US Equit";0;5;"INTL BUSINESS MACHINES CORP";"INTL BUSINESS ";143.440000 ;143.440000 ;143.44000000 ;
END-OF-DATA
TIMEFINISHED=Tue May 15 12:44:45 EDT 2018
END-OF-FILE

## Request File 3
## This sample shows request with 'SECDESLENGTH=12' and 'OUTPUTFORMAT=fixed'.
## The rest of parameters are equal to the previous sampe.

START-OF-FILE
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_fixed.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=fixed
SECDESLENGTH=12
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST||8
END-OF-FIELDS
START-OF-DATA
IBM US Equity||
END-OF-DATA
END-OF-FILE

## Reply File 3

START-OF-FILE
RUNDATE=20180515
FIRMNAME=dlxxxxxx
REPLYFILENAME=formatting_fixed.out
PROGRAMNAME=getdata
PROGRAMFLAG=adhoc
OUTPUTFORMAT=fixed
SECDESLENGTH=12
CLOSINGVALUES=yes
START-OF-FIELDS
NAME
NAME|16
PX_LAST
PX_LAST||8
END-OF-FIELDS
TIMESTARTED=Tue May 15 11:58:16 EDT 2018
START-OF-DATA
IBM US Equit0 4 INTL BUSINESS MACHINES CORP INTL BUSINESS MA143.610000 143.61000000
END-OF-DATA
TIMEFINISHED=Tue May 15 11:58:34 EDT 2018
END-OF-FILE

This section lists examples of Per Security requests in order to show how format of the output data is influenced by the various request parameters

Request formatting is determined by the following parameters:

field width and decimal places parameters described in FIELDS related chapter

OUTPUTFORMAT parameter described in the OUTPUTFORMAT chapter

DELIMITER parameter described in the DELIMITER chapter

SECDESLENGTH parameter described in the SECDESLENGTH chapter

NOTE:

All text fields are surrounded by double quotes in ‘Reply File 2’ since delimiter differs from Unix pipe “|”.

Security identifier (“IBM US Equit”) in ‘Reply File 2’ is two characters shorter ‘Reply File 1’ since double quotes took place.

No delimiters are presented in the ouput in in ‘Reply File 3’ since the OUTPUTFORMAT is set to fixed

Securities
The list of securities must be after the list of fields, with one security identifier per line.

Limits per request:

A maximum of 20,000 securities may be requested in a single request via an Adhoc mode under Scheduled Service or via legacy Per Secur

A maximum of 200,000 securities may be requested in a single getData request via a Scheduled mode under Scheduled Service. Other pr

Text

## Securities must be listed between the following two declarations

START-OF-DATA
<Securities>
END-OF-DATA

Any text inserted between END-OF-DATA and END-OF-FILE will not be returned in the output.

Bloomberg DL may insert comments in the area between END-OF-DATA and END-OF-FILE at any time.

Text

## In order to specify the requested security the following formats can be used:
<Identifier> | <Security Identifier>
<Identifier> <Market Sector>
<Identifier> <Market Sector> | <Security Identifier> |
<WildCard> | MACRO |
## Format Example: shows the ways of specifying the securities in 'Per Security' requests.

Argument Description

Identifier Required

Security Identifier Must be one of the identifiers described in SECID chapter. This security descriptor is limited to 32 ch
It is also possible to identify securities using security descriptions such as Ticker/Coupon/Maturity or
Some security identifiers apply to multiple securities from multiple exchanges. It is possible to specify

Market Sector Optional, but recommended. Must be one of the standard Bloomberg market sectors specified prev

Wildcard An expression that represents a universe of securities. See Security Wildcards section below.

When both Security Identifier and Market Sector options are specified, the Security Identifier option takes precedence. For example, if Security Ide

Comment lines can be included in SFTP Request files (not in Web Services requests), and must be preceded by a # sign. In the above example, the

Security Wildcards
Security wildcards (or macros) represent a group or universe of securities.

Wildcards are meant to facilitate downloading large groups of related securities and security list maintenance. They are not designed to function a

Wildcards are placed in the data section of a request. In general, wildcards should be treated as any other data request with the addition of | MAC

Note: You will be billed for all securities that are delivered when using a wildcard/macro.

Wildcards can also be used in getHistory, getQuotes, getAllQuotes, and getActions programs.

The general syntax for wildcard usage in a request is:

macrotype = primary qualifier [AND secondary qualifier = value [AND secondary qualifier = value AND ...] ...]

The following macrotypes can be used as wildcards:

Macrotype Description Primary Qualifier

BOND_SRCH Bond search The custom criteria set number.

Macrotype Description Primary Qualifier

EQUITY_SRCH Equity search The custom criteria set number.

EXCH Equity exchanges Two character exchange code, e

INDEX Equity indices The index ticker symbol.

PFD_SRCH Preferred Bond Search The custom criteria set number.

PORTFOLIO Your portfolio The portfolio # from PRTU<GO>

SECTYP Security type The security type descriptor.

SRCH and PSCH Wildcards

To download a specific search that has been set up via the Bloomberg Terminal® functions SRCH and PSCH, all you need to specify is the custom c

For example, if you want to download SRCH criteria set number 3, in the data section of the request, this would be specified as:

BOND_SRCH = 3 | MACRO

All bonds that match the given criteria will be returned with the fields that you requested.

Portfolio Wildcards
The below listed PORTFOLIO wildcards allow you to use an existing portfolio’s security set. The line format is the same as the bond search. For exa

PORTFOLIO = 1523 | MACRO

A Port # can be found on Portfolio Administration (PRTU <GO>) function on the Bloomberg Terminal. The Port #’s are listed on the far right of the Y

The PRP header option can be used with the PORTFOLIO macro. For example, PRP=1 will return fields in PRP Setup #1. For further details, see Requ

Note: Shared Portfolios can be assigned the same number as an existing Portfolio. In this case, you would need to create a new Portfolio and use t

In contrast, the line format for the PORTFOLIO wildcard that applies to BVAL Derivatives Portfolios stored in BVPM<GO> is as follows:

PORTFOLIO=BVALOTC:<portfolio name>|MACRO

A portfolio name can be found on the BVAL Derivatives Portfolio Manager (BVPM<GO>) function on the Bloomberg Terminal. The portfolio names

PORTFOLIO=BVALOTC:Money Maker|MACRO

The Portfolio MACRO also supports overrides. In order to add an override, simply append the override values after the word MACRO.

EQS Wildcards
To obtain the unique identifier to use in the EQUITY_SRCH macro, login to the Bloomberg Terminal using the login name that has the equity searc

You must use the number in the ID column against the search name you have created.

Example:

EQUITY_SRCH=8606101 |MACRO

Security Types (SECTYP) Wildcards

The following table lists all available primary qualifiers (security type descriptors) for SECTYP:

Security Type

ABS

BASIS_SW_CRNCY

CD_CRNCY
Security Type

CMBS

CMO

CONVERTS

CONVERTS_PFD

CONVERTS_UNDERLYING

CONVERTS_PFD_UNDERLYING

CORPORATES

CORP_PFD

CORP_PFD_DOMESTIC

CORP_PFD_INTERNATIONAL

CPS_FLRS_CRNCY

CROSS_CRNCY

DELIVERABLE_BONDS

DEPOSIT_CRNCY

EQUITY_INDEX

EURODOLLAR_BOND

FHLMC_GOLD_POOL

FHLMC_POOL

FNMA_POOL

FORWARD_CRNCY

FRA_CRNCY

FUT_CHAIN

GNMAI_POOL

GNMAII_POOL

GOVT_AGENCY

GOVT_NATIONAL

GOVT_REGIONAL

LOAN

NDF_CRNCY

NDF_SW_CRNCY

ONSH_CRNCY

ONSH_SW_CRNCY

OPT_CHAIN

OPT_VOL_CRNCY

PFD_BOND
Security Type

QUARTER_CRNCY

REPO_CRNCY

SEMI_CRNCY

SPOT_CRNCY

SUPRA_NATIONAL

SWAP_CRNCY

SWAP_SPR_CRNCY

SWAP_VOL_CRNCY

US_TREASURY

WHEN_ISSUED

WHOLE_LOAN

X_FWD_CRNCY

All matured bonds are weeded out of the list of securities returned.

Must be used in conjunction with the secondary qualifier SECURITY_DES.

In the code below:

The first example returns all members of the Dow Jones Industrials (ticker = INDU).

The second example retrieves all listings on the New York Stock Exchange (NYSE).

The third example generates the list of all convertible bonds in the corporate database.

Text

## Wildcards are placed between "START-OF-DATA" and "END-OF-DATA" in the request as follows:

The following code returns daily high prices for members of the S&P 500 Index from June 15, 2002 through June 15, 2003:

URI

Secondary Qualifiers for SECTYP Wildcards

Secondary qualifiers are optional and can be used to limit or constrain wildcards to a subset of securities. They must be preceded by AND.

The following table lists all secondary qualifiers and to which macrotypes/primary qualifiers these apply:
Secondary Qualifier Description

ACTIVE_PRICING Actively priced exchange traded equities

CPN_TYP Coupon type

COUNTRY Country CDR code

CRNCY Currency(ISO code)

EXCH_TRADED Exchange traded preferred bonds

LQA_TGT_LIQUIDATION_VOLUME/PY247 Defines volume used to estimate Liquidation Cost, Liquidation Horizon, or related outputs.

LQA_SEC_22E4_TRADE_SIZE/PY368 Defines anticipated amount to be liquidated in order to classify the liquidity of a position according to the Sec

LQA_MODEL_AS_OF_DATE/PY369 Defines the as of date for backdating the LQA Model.

MATURED Matured Securities

SECURITY_DES Security description

RATING Bloomberg composite rating

SECURITY_TYP Security type

SERIES Series of corporate bond

TICKER Ticker symbol

WAC Weighted average coupon for mortgage pools

The macro may not contain any of the following security level overrides: LQA_TGT_LIQUIDATION_VOLUME (PY247), LQA_SEC_22E4_TRAD

Currently available security types for the secondary qualifier SECURITY_TYP are listed below:

SECURITY_TYP

AMERICATRUST

CLOSEENDFUND

COMMON

MONEYMARKET

MUTUAL

OFFSHOREFUND

OPTION

RECEIPT

RIGHT

UKTRUST

UNIT

WARRANT

SECURITY_TYP=COMMON will return the securities that were listed on an exchange as of the previous day. For example, if a security is added to a

Secondary qualifiers use the operators =, != (not equal to), > and <. Some examples of secondary qualifiers are:

SECTYP=CORPORATES AND CRNCY=USD AND COUNTRY=US|MACRO All corporate bonds issued by the U.S. in U.S. dollars
SECTYP=GOVT_REGIONAL AND COUNTRY!=CA AND CRNCY=FRF|MACRO All regional government bonds, not issued by Canada, denominated in

SECTYP=GOVT_NATIONAL AND COUNTRY=CH|MACRO All government national bonds issued by China

SECTYP=GOVT_AGENCY AND RATING=AAA AND CRNCY=BE|MACRO All government agency bonds, issued by Belgium, rated AAA

SECTYP=US_TREASURY AND TICKER=T|MACRO All U.S. treasuries with T as the ticker symbol

EXCH=UN AND SECURITY_TYP=COMMON|MACRO All common stocks listed on the New York Stock Exchange.

For example, the first macro below returns all deliverable bonds for the US long bond future and the second returns all options for IBM’s US listing

Text

## The deliverable bonds, futures contracts and option chain macros require the secondary qualifier SECURITY_DES.

SECTYP=DELIVERABLE_BONDS AND SECURITY_DES=USA Comdty|MACRO

SECTYP=OPT_CHAIN AND SECURITY_DES=IBM US Equity|MACRO

In the code below:

The first example retrieves government agency bonds that are rated higher than B2 and lower than A3.

The second example gets corporate bonds that are rated lower than AAA and higher than B1.

The next example is for convertible bonds that are lower than AA1.

Text

## Ranges can be specified for the secondary qualifiers NET_CPN, RATING, WAC, WALA and WAM by using > and < symbo

SECTYP=GOVT_AGENCY AND RATING>B2 AND RATING<A3|MACRO

SECTYP=CORPORATES AND RATING<AAA AND RATING>B1|MACRO
SECTYP =CONVERTS AND RATING<AA1|MACRO
SECTYP=GNMAI_POOL AND NET_CPN>6.9 AND NET_CPN<8.0|MACRO
SECTYP=FHLMC_POOL AND WAC>7.25|MACRO

In general, wildcards are easy to use and expedite the generation of lists of securities of a given group. Some basic syntax rules for wildcards follo

Wildcards must begin with a macrotype (e.g., INDEX) followed by an equal sign (=). Only one macrotype is allowed per line.

The order of secondary qualifiers (e.g., CRNCY) does not matter.

Secondary qualifiers must be preceded by AND.

Only one type of secondary qualifier can be specified per line (except RATING and Mtge qualifiers). For example, COUNTRY = CA AND COUN

Either a range of RATINGs can be specified or one RATING can be asked for, but not both. That is, either use RATING > ??? AND RATING <

A maximum of seven secondary qualifying statements (e.g., TICKER = T) are allowed per line. Any secondary qualifying statement beyond

Return Codes
In general, any non-zero return code means an error has occurred.

Possible return codes for wildcards are:

Return Code Description

0 Good return. N

500 Invalid wildcard

501 Unknown macr

Return Code Description

502 Unknown secon

503 Unknown EXCH

504 Unknown INDE

505 Unknown SECT

506 Unknown CRNC

507 Internal databa

508 Unknown COU

509 Internal databa

510 Invalid operato

511 Invalid RATING

512 Multiple second

513 Invalid CPN_TY

514 Invalid Mtge re

515 Invalid Mtge RA

516 Internal databa

517 Options not ava

518 Deliverable bon

519 Futures not ava

520 Search error.

521 Portfolio error.

Data Types
The following table describes the data types returned by the Per Security programs:

Type Description

Character One or more consecutive characters

Date Date format including month, day and year. e.g., YYYYMMDD, mm/dd/yyyy

Time Time format including hours, minutes and seconds, e.g., hh:mm:ss

Date or Time Either date or time date type

Bulk Format Serialized representation of multiple data types (separated by a specific deli

Month/Year month yy, mm/yy or mm/yy PERIOD, where PERIOD could be Q[1-4], Y etc.

Boolean Y or N

Integer Zero, natural number and negative numbers

Type Description

Real A floating point integer with up to six significant digits

Price Either a floating point integer with up to six significant digits or special Bloom

Integer/Real Either integer or real data type

Long Character Extended character

These data types are referenced in the following chapters, for example in the following program names

getdata

gethistory

Data Types Format

A data type appears in documentation in the following form:

Type (max characters)

For example:

Type Description

Character (10) String that takes up to 10 c

Integer (8) Integer that can take up to

Time (8) Time (hh:mm:ss) takes exa

Request Operation Mode

To specify when a request should run, the request operation mode (Scheduled/Oneshot/Adhoc) should be set by PROGRAMFLAG.

If the PROGRAMFLAG header parameter is not specified, the program defaults to oneshot.

For PROGRAMFLAG values descriptions: PROGRAMFLAG documentation.

Scheduled
Scheduled requests are repeating requests, on regular schedules. They provide access to the most recent pre-calculated data and are recommend

A minimum of 15 minutes notice is required to schedule a request.

Scheduled requests are known to Bloomberg in advance, and this may help with faster responses.

Oneshot
Oneshot requests are non-recurrent scheduled requests (meaning they run once). These requests are an effective way to get information about a l

A minimum of 15 minutes notice is required to schedule a oneshot request. A oneshot request may have a specific date and time supplied. When

The disadvantage of a oneshot request is that it may sometimes take longer to get a response than a scheduled request.

Adhoc
Adhoc requests are run immediately, gathering the latest available data. They are an effective way to get information quickly about securities.

Response times are more variable than for other modes, especially for large requests. If you include calculated fields, such as analytics, the time ta

Adhoc requests may not have a RUNTIME or RUNDATE header specifying a time or date, as these requests only run immediately.
Operation Mode Consequences
The choice of request operation mode has a consequence on scheduling features, content availability, program availability, and rate card pricing.

For definitions of operation modes: PROGRAMFLAG documentation.

Scheduling Features

Feature

RUNDATE or RUNTIME Support

Notice Period

Start Delay

Content Availability
You can request any type of content in either adhoc or scheduled mode:

Reference Data

Pricing

Regulatory

Calculation Services

Security Limits
The same security limits apply for both adhoc and scheduled modes.

Program

getData

getActions

getTickHistory

getQuotes

getAllQuotes

getHistory

getSnap

getCompany

Rate Card

Pricing

Embargos
Data License (DL) is a Bulk data feed. To ensure this, both adhoc and scheduled modes are subject to embargos: requests are performed when re

All requests have a 50 second embargo. In addition, requests deemed to be too frequent in the same security are subject to an additional embarg
Program Names
Program name is a request parameter that:

Defines the program, i.e., the category of data returned by the Per Security request.

Is declared by the PROGRAMNAME parameter in the request header.

Each request should have only one program name.

The following is the table with all the programs currently available under the Data License (DL) Per Security service:

Program Name Description

getData Returns data for a specified list of securities.

getHistory Returns historical data for a specified list of securities within a given date ran

getTickHistory Returns historical quotes and trades tick by tick data.

getQuotes Returns last execution pricing data, time stamped with date, hour, minute and

getAllQuotes Similar to getQuotes, but also returns matching ask and bid prices.

getActions Returns corporate actions for a specified list of securities (and the issuer of th

getCompany Returns company/entity level data, such as industry classification, country of

getSnap Returns pricing data with higher precision at a specified time or valuation po

cancel Cancels a currently scheduled request.

cancel_all Cancels a list of currently scheduled requests.

scheduled Returns a report containing all recurrent requests that are currently schedule

Note:

If the PROGRAMNAME header parameter was not specified the program will be defaulted to getData.

Not all of the PROGRAMFLAG values could be used with every Program Name, please see PROGRAMFLAG documentation.

For DL+, you can only use getData. Your DL Account fulfills all other requests.

getData
The getData program returns requested data for a list of data fields and a list of securities.

One record is returned per security identifier.

Fields are pipe-delimited and of variable width.

Format:

<Identifier>| <Rcode> | <Nfields> | <Value-1> | <Value-2> | ... | <Value-Nfields> |

Field

Identifier

Rcode

Nfields

Value-1 … Value-Nfields
Example getData Request

Text

## Sample request
# Note:
# `PROGRAMFLAG` was not specified in request, so that `PROGRAMFLAG` is
# defaulted to `oneshot` by the 'Data License' service

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=getdatatest.out
PROGRAMNAME=getdata

START-OF-FIELDS
NAME
TICKER
CPN
MATURITY
END-OF-FIELDS

START-OF-DATA
#Requesting the T14 Govt bond in 4 different ways
912810CY2 |CUSIP
US912810CY20 | ISIN
000863149 | VALOREN
T14 11/15/11 Govt
#Coupon and Maturity do not apply to equities, so blanks are returned
IBM US Equity
# 'Fake Equity' here is not a valid security, return code 10 and NO data is
# returned
Fake Equity
END-OF-DATA

END-OF-FILE
## Sample reply

START-OF-FILE
RUNDATE=20050509
PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
REPLYFILENAME=getdatatest.out
PROGRAMNAME=getdata

START-OF-FIELDS
NAME
TICKER

Overrides
With getData, you can perform calculation overrides to certain data fields. This allows you to submit data that can leverage Bloomberg standard m

The value of an overriding value field is altered to affect the return of another field. There is a limit of 19 overrides per record. Fields that are not aff

Note that if the override is used improperly, incorrect or unexpected data may be returned, or the request may not process at all.

Note: Additional fees may be incurred with use of this feature. For more details, contact your Bloomberg account representative.

Override request format:

<Identifier>||<Number of Overrides>|<Overriding Field>|<Overriding Value>|

Example:

XS014289826 Corp||1|SETTLE_DT|20161111|

Example getData Override Request

Text

## Sample Request for an override in the getData program:

START-OF-FILE
FIRMNAME=firmabc
REPLYFILENAME=override.out
PROGRAMNAME=getdata
PROGRAMFLAG=oneshot

START-OF-FIELDS
MTG_PREPAY_TYP
MTG_PREPAY_SPEED
MTG_WAL
END-OF-FIELDS

START-OF-DATA
073914VW0 Mtge||2|MTG_PREPAY_TYP|MTG_PREPAY_SPEED|CPR|90|
END-OF-DATA
END-OF-FILE

Pricing Differences
You may see differences in price data between the responses to your getData requests and the Bloomberg Terminal®. The most common reasons

Equities:

Defaults: For historical equity pricing, the price adjustment settings on the Corporate Actions Settings (DPDF <GO>) function on the B

Exchange Defaults: If you do not specify the exchange for an equity (for example, you use ISIN US0378331005 or SEDOL 2588173 wit

Time of Request Submission: Equity prices are liquid and change throughout the day, so the information you see on the Bloomberg T

Different Data Field: The data field you are using in your request may be different than what you see on the Bloomberg Terminal func

End-of-day: End-of-day equity price updates are determined by each exchange. Check the exchange trading hours when you are de

Fixed Income:

Different Pricing Sources: If your request is not linked to the Bloomberg Terminal, you will use the default hierarchy of pricing sources

Time of Request Submission: Fixed income prices may change throughout the day, so the information you see on the Bloomberg Ter

Different Data Field: The data field you are using in your request may be different than what you see on the Bloomberg Terminal func

Indices: Index prices often require additional entitlements from the pricing provider. Without the entitlement, you may see an embargo bei

BVAL Pricing

BVAL Pricing in DL

You can access BVAL® evaluated pricing for fixed income securities via the DL getdata and gethistory programs.

The Bloomberg Valuation (BVAL) Service is an independent information source that draws on market data contributed from thousands of market p

To receive BVAL price snapshots via the getdata program, you must set specific header options in your request:

BVALTIER
BVALSNAPSHOT
BVALSNAPSHOTDATE

Header Mnemonic Description

BVALTIER 1 or 2 are the only options

BVALSNAPSHOT Allows you to select snapshot time, such as NY 4:00 PM

BVALSNAPSHOTDATE Allows you to select snapshot date in the format YYYYMMDD

BVAL Snapshot Times

You should set BVALTIER= to 1 or 2, depending on which Tier you are requesting. BVALSNAPSHOT accepts the following values, which correspond t
Snapshot Code Description

NY3PM New York 3:00 PM

NY4PM New York 4:00 PM

LO12PM London 12:00 PM

LO3PM London 3:00 PM

LO4PM London 4:15 PM

TO3PM Tokyo 3:00 PM

TO4PM Tokyo 4:00 PM

TO5PM Tokyo 5:00 PM

SY5PM Sydney 5:00 PM

SH5PM Shanghai 5:00 PM

BVAL Snapshot Date Validation

You must specify the snapshot date when you request a particular BVAL snapshot. The field SNAPSHOTDATE represents the date, defined as YYYYMM

Bloomberg performs SNAPSHOTDATE validation as follows:

Date Validation Result

Snapshot date > date today HOLD request

Snapshot date < date today REJECT request

Snapshot date = date today PROCESS file if request was submitted prior to the cutoff time*; otherwise, REJECT

* The cutoff time is defined as 2.5 hours after the snapshot for a Tier 1 Request and the snapshot time itself for a Tier 2 request.

BVAL Tier Comparison

The table below compares BVAL Tier 1 and Tier 2 services. The Tier you specify in your requests depends on the agreed service levels in your firm’

Feature T

Available Data A

Submit Files U

Start of processing A

Delivery Time W

Field Sets/Macros T

Security level PCS overrides available Y

BVAL Tier 1
All snapshots are available for Tier 1 clients, and only BVAL prices are returned.

If you want to receive pricing for a given snapshot, you can submit requests up until 2.5 hours after the requested snapshot time.

If you select a snapshot date of today, and you submit the request after the cutoff time, the request will be rejected.

If you select no date or select a future date, the request is held and processed the following day.
Once BVAL determines a submitted request to have met the date and time restrictions, the submission is validated. If there is an error, the respons

When you have submitted a successful request prior to the snapshot time, you will receive pricing within 45 minutes after the specified snap

Files submitted after the snapshot time begin delivery after the files submitted before the snapshot time have been delivered.

If there is no BVAL price for a security on a given day, no price will be returned as indicated by N.A. in the response.

BVAL Tier 2
All snapshots are available for Tier 2 clients, and only BVAL prices are returned. You must submit your requests prior to the snapshot to receive pri

Tier 2 requests go through the same validation process as Tier 1 requests, i.e., a response is generated.

If there is no BVAL price for a security on a given day, no price will be returned as indicated by N.A. in the response.

BVAL Snapshot Requests

The example request below incorporates the BVAL Tier and Snapshot headers. The code shows a Tier 2 request for BVAL New York 4:00 PM bid p

Where:

START-OF-DATA and END-OF-DATA contain the CUSIPs identifying each bond.

BVALTIER specifies BVAL Tier 2.

START-OF-FILE
FIRMNAME=dlxxxxxx
REPLYFILENAME=BVAL_Tier2_Sample
CLOSINGVALUES=yes
DERIVED=yes
PROGRAMFLAG=weekday
SECID=CUSIP
SECMASTER=yes

BVALTIER=2
BVALSNAPSHOT=NY4PM
BVALSNAPSHOTDATE=20220731

PROGRAMNAME=getdata
START-OF-FIELDS
BVAL_BID_PRICE
BVAL_BID_YIELD
BVAL_BID_SCORE
END-OF-FIELDS
START-OF-DATA
459200AM3
037833BG4
END-OF-DATA
END-OF-FILE

BVAL Pricing via Standard PCS Request

You can also receive Tier 2 BVAL prices via a standard pricing source (PCS) request outside of the Tier requests. BVAL PCS requests are processed

If no snapshot is selected, i.e., PRICING_SOURCE=BVAL, the most recent BVAL price given the 2.5-hour embargo is returned. For example, a r

If a snapshot is selected, e.g., PRICING_SOURCE=BVAL:NY4PM, a request submitted at 2:30 PM NY time returns the BVAL prices from the prev

If linking to a Bloomberg Terminal®, the snapshot price returned matches your settings in the Pricing Sources (PCS <GO>) function.

As is standard with PCS requests, older prices may be returned in those instances when there is no BVAL price on a given day for a bond that prev

If PRICING_SOURCE=BVAL and EXCLUSIVE_PRICING_SRC=yes, it is possible that a BVAL price from a previous snapshot will be returned.

If PRICING_SOURCE=BVAL and EXCLUSIVE_PRICING_SRC=no, it is possible a price from a previous snapshot may be returned from either BVA
BVAL PCS Codes
As a BVAL customer, you can use any of the eight PCS (pricing source) codes:

PCS Definition

BVAL Latest BVAL

BVT3 or BVAL:TO3PM Tokyo 3:00 PM

BVT4 or BVAL:TO4PM Tokyo 4:00 PM

BVT5 or BVAL:TO5PM Tokyo 5:00 PM

BL12 or BVAL:LO12PM London 12:00 PM

BVL3 or BVAL:LO3PM London 3:00 PM

BVL4 or BVAL:LO4PM London 4:15 PM

BVN3 or BVAL:NY3PM New York 3:00 PM

BVN4 or BVAL:NY4PM New York 4:00 PM

BVS5 or BVAL:SY5PM Sydney 5:00 PM

BSH5 or BVAL:SH5PM Shanghai 5:00 PM

Note: The Muni and Mortgage asset classes only use BVAL, BVN3 (or BVAL:NY3PM) and BVN4 (or BVAL:NY4PM).

BVAL PCS Requests

The code example below shows a PCS request for BVAL:NY4PM bid, yield, and score on the current date for Google and Netflix callable bonds m

Where:

START-OF-DATA and END-OF-DATA contain the CUSIPs identifying each bond.

EXCLUSIVE_PRICING_SRC when set to yes indicates a PCS request (not a snapshot).

PRICING_SOURCE specifies the BVAL:NY4PM (BVN4) PCS code.

START-OF-FILE
FIRMNAME=dlxxxxxx
EXCLUSIVE_PRICING_SRC=yes
REPLYFILENAME=BVAL_PCS_Sample
PRICING_SOURCE=BVAL:NY4PM
CLOSINGVALUES=yes
SECID=CUSIP
SECMASTER=yes
PROGRAMNAME=getdata
START-OF-FIELDS
BVAL_BID_PRICE
BVAL_BID_SCORE
END-OF-FIELDS
START-OF-DATA
02079KAD9
64110LAV8
END-OF-DATA
END-OF-FILE

Pricing Hierarchy Without PCS Specified

The table below displays the PRICING_SOURCE hierarchy for BVAL when the request specifies no PCS.
GSAC Mortgage Municipal

BGN BVAL BVAL

TRAC

BVAL

Return Codes
The following return codes are supported for getData:

Code Description

0 Good return. No errors occurred.

9 Asset class not supported for BVAL Tier1 pricing.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

123 User not authorized for private loan (PRPL).

605 Invalid macro value.

988 System Error on security level.

989 Unrecognized pricing source.

990 System Error. Contact Product Support and Technical Assistance.

991 Invalid override value (e.g., bad date or number) or Maximum number of overrides (20) exceeded.

992 Unknown override field.

993 Maximum number of overrides exceeded

994 Permission denied.

995 Maximum number of fields exceeded.

996 Maximum number of data points exceeded (some data for this security is missing).

997 General override error (e.g., formatting error).

998 Security identifier type (e.g., CUSIP) is not recognized.

999 Unloadable security

Data Not Returned

It is possible to get a good return code for getData, but data for one or more data fields has not been returned. Reason Codes and reasons for fie

Reason Code Reason

A blank field is returned, because requested field and security combination is not

N.A. Data is missing, because Bloomberg does not have the data.

N.D. Not downloadable, because you do not have permission to download the field.

N.S. Not subscribed, because you 1) are not entitled to download the requested field a

FLD UNKNOWN Field unknown to Bloomberg.

getHistory
The getHistory program retrieves historical data for a specified list of securities within a given date range. There are no limits on how far back his

Web Services
For more on Web Services: Get History (Web Services).

SFTP
Fields are listed between the START-OF-FIELDS and END-OF-FIELDS in the request. For a list of fields available in the getHistory program, see th

For instructions on establishing a date range, see DATERANGE.

Responses for the getHistory program are always compressed regardless of whether COMPRESS=yes is in the request. Responses may be decomp

Equity Volume and Price Adjustments

For equities, by default, the getHistory program adjusts volume and price history for splits. Historical prices are not adjusted for cash dividends.

If you want prices that are un-adjusted for splits:

Use Bloomberg Corporate Actions data to get the adjustment factors and adjust accordingly.

Retrieve the fields EQY_SPLIT_ADJUSTMENT_FACTOR (Split Adjustment Factor) and EQY_DVD_ADJUST_FACT (Equity Dividend Adjustment Facto

If you are also using the Bloomberg Terminal®, replicate the settings you have in the Corporate Actions Settings (DPDF <GO>) function by li

Note: For split adjustments description, see this split adjustments article.

Response Format
The response format of a getHistory response is determined by the HIST_FORMAT header option.

Using the HIST_FORMAT header, you can specify one of the following output formats:

Vertical (the default): vertical

Horizontal: horizontal

The schema of a response data section in vertical format:

START SECURITY | <Identifier> | <Field mnemonic> |

The schema of a response data section in horizontal format:

Field Desc

Identifier The

Rcode The

NumFields The

Date-1 … Date-N The

Value-1 … Value-N The

Note:

The date format is mm/dd/yyyy by default, but can be overridden by the DATEFORMAT header option.

The program can retrieve up to 15,000 points of data per field, with a maximum of 60,000,000 points in horizontal format and 30,000,000

The schema of a response data section in horizontal format is described below:

Example Request/Response: Vertical

Text

## Sample request with default vertical format

# Note:
# `PROGRAMFLAG` was not specified in request, so that `PROGRAMFLAG` is
# defaulted to `oneshot` by the 'Data License' service

START-OF-FILE
FIRMNAME=your_dl_login_name
# Compression is done automatically for ALL gethistory requests
COMPRESS=yes
REPLYFILENAME=testhistorypc.out
DATERANGE=20090504|20090508
PROGRAMNAME=gethistory
START-OF-FIELDS
PX_ASK
PX_BID
END-OF-FIELDS
START-OF-DATA
US912828KN98|ISIN
INTC US Equity
END-OF-DATA
END-OF-FILE
## Sample reply with default vertical format

START-OF-FILE
RUNDATE=20050519
PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
# Compression is done automatically for ALL gethistory requests
COMPRESS=yes
REPLYFILENAME=testhistorypc.out
DATERANGE=20090504|20090508
PROGRAMNAME=gethistory
START-OF-FIELDS
PX_ASK
PX_BID
END-OF-FIELDS
TIMESTARTED=Mon May 18 10:14:30 EDT 2009
START-OF-DATA
START SECURITY|US912828KN98 | PX_ASK |
US912828KN98|05/04/2009|99.296875|
US912828KN98|05/05/2009|99.1875|
US912828KN98|05/06/2009|99.171875|
US912828KN98|05/07/2009|98.609375|

Example Request/Response: Horizontal

Text

## Sample request file with optional horizontal format

START-OF-FILE
FIRMNAME=your_dl_login_name
# Compression is done automatically for ALL gethistory requests
COMPRESS=yes
REPLYFILENAME=testhistorypc.out
DATERANGE=20090504|20090508
# HIST_FORMAT has been set to 'horizontal'
HIST_FORMAT=horizontal
PROGRAMNAME=gethistory
START-OF-FIELDS
PX_ASK
PX_BID
END-OF-FIELDS
START-OF-DATA
US912828KN98|ISIN
INTC US Equity
END-OF-DATA
END-OF-FILE
## Sample reply file with option horizontal format

START-OF-FILE
RUNDATE=20050519
PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
# Compression is done automatically for ALL gethistory requests
COMPRESS=yes
REPLYFILENAME=testhistorypc.out
DATERANGE=20090504|20090508
# HIST_FORMAT has been set to 'horizontal'
HIST_FORMAT=horizontal
PROGRAMNAME=gethistory
START-OF-FIELDS
PX_ASK
PX_BID
END-OF-FIELDS
TIMESTARTED=Mon May 18 10:15:17 EDT 2009
START-OF-DATA
US912828KN98|0|2|05/04/2009|99.296875|99.28125|
US912828KN98|0|2|05/05/2009|99.1875|99.171875|
US912828KN98|0|2|05/06/2009|99.171875|99.15625|
US912828KN98|0|2|05/07/2009|98 609375|98 59375|

Overrides
With getHistory, you can perform calculation overrides to fundamental data fields. This allows you to submit data that can leverage Bloomberg s

Override request format:

<Identifier>|<Number of Overrides>|<Overriding Field>|<Overriding Value>|

Example:

SALES_REV_TURN|1|AE|E|

Override Name Override Abbreviation (i.e., Overriding Field)

Actuals or Estimates AE

Label L

BVAL Pricing

BVAL Pricing in DL

You can access BVAL® evaluated pricing for fixed income securities via the DL getdata and gethistory programs.

The Bloomberg Valuation (BVAL) Service is an independent information source that draws on market data contributed from thousands of market p

BVAL Historical Prices

BVAL historical pricing is available using any of the following methods:

Historical Range: gethistory program

BVAL Fields: PX_CLOSE_1D, 2D, etc.

BVAL Historical Requests

When forming a BVAL gethistory request, you must specify:

BVAL snapshot
BVAL as the pricing source (PCS)

Start date and end date

The code example below shows a historical request for the BVN4 bid prices and BVAL scores from January to July 2022 for an Amazon callable bo

Where:

START-OF-DATA and END-OF-DATA contain the CUSIP identifying the bond.

DATERANGE= defines the start and end dates of the range for the requested data.

PRICING_SOURCE specifies the BVAL:NY4PM PCS code.

START-OF-FILE
FIRMNAME=dlxxxxxx
COMPRESS=yes
REPLYFILENAME=BVAL_GetHistory_Sample
PRICING_SOURCE=BVAL:NY4PM
DATERANGE=YYYYMMDD|YYYYMMDD
SECID=CUSIP
PROGRAMNAME=gethistory
START-OF-FIELDS
BVAL_BID_PRICE
BVAL_BID_SCORE
END-OF-FIELDS
START-OF-DATA
023135CH7
END-OF-DATA
END-OF-FILE

Fundamental Financial Analysis

You can use the getHistory program to request historical fundamental data and future estimates, so you can analyze the value of a potential inve

NOTE

These instructions assume you already understand the basics of using the API to define, submit and maintain data set requests. You can request any field in the Fu

Large-Cap Technology Company Fundamentals

You can gauge past performance as well as future expectations for large cap tech companies with two requests, thereby acquiring data for a earni

The following example provides ten years of historical data (i.e., from Jan 1, 2014 to the current date) as well as two years of forward-looking estima

Revenue

Operating Income or Losses

Net Income/Net Profit (Losses)

Basic Earnings per Share

Diluted EPS

Gross Margin

Operating Margin

Price to Sales Ratio

Current Price to Free Cash Flow

Last Price

1. Request actual, reported data for historical dates (i.e., from Jan 1, 2014 until the current date).
HINT

Note the following options within the request:

SFTP (Bash)

Field List (i.e., START-OF-FIELDS): does not include any overrides because the service returns A for actual reported data for Jan 1

Headers:

DATE_TYPE, FA_ADJUSTED, and FA_PERIOD: show the default values for each option.

FIRMNAME: enter your Data License account number, provided by your Implementation Specialist.

DLWS (XML)

Field List (i.e., <ns:fields>): does not include any overrides because the service returns a for actual reported data for Jan 1, 2014

Headers: <ns:date_type>, <ns:fa_adjusted>, and <ns:fa_period>: show the default values for each option.
For more: Request Headers.

Example Historical Tech Fundamentals Request

XML

1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://services.bloomberg.

2 <soapenv:Header/>
3 <soapenv:Body>
4 <ns:submitGetHistoryRequest>
5 <ns:headers>
6
7 <ns:daterange>
8 <ns:period>
9 <ns:start>2014-01-01</ns:start>
10 <ns:end>2026-05-31</ns:end>
11 </ns:period>
12 </ns:daterange>
13
14 <ns:programflag>adhoc</ns:programflag>
15 <ns:display_pricing_src>true</ns:display_pricing_src>
16 <ns:fa_adjusted>N</ns:fa_adjusted>
17 <ns:fa_period_type>Q</ns:fa_period_type>
18 <ns:date_type>periodend</ns:date_type>
19
20 </ns:headers>
21 <ns:fields>
22
23 <ns:field>SALES_REV_TURN</ns:field>
24 <ns:field>IS_OPER_INC</ns:field>
25 <ns:field>NET_INCOME</ns:field>
26 <ns:field>IS_EPS</ns:field>
27 <ns:field>IS_DILUTED_EPS</ns:field>
28 <ns:field>GROSS_MARGIN</ns:field>
29 <ns:field>OPER_MARGIN</ns:field>
30 <ns:field>PX_TO_SALES_RATIO</ns:field>
31 <ns:field>CURRENT_PX_TO_FREE_CASH_FLOW</ns:field>
32 <ns:field>PX_LAST</ns:field>
33
34 </ns:fields>
35 <ns:instruments>
36
37 <ns:instrument>
38 <ns:id>AAPL US Equity</ns:id>
39 </ns:instrument>
40 <ns:instrument>
41 <ns:id>MSFT US Equity</ns:id>
42 </ns:instrument>
43 <ns:instrument>

2. Request consensus estimates for historical and future dates (i.e., from Jan 1, 2014 until the current date).
HINT

Note the following options within the request:

SFTP (Bash)

Field List (i.e., START-OF-FIELDS):

includes the AE|E override to request historical and future estimates from Jan 1, 2014 to May 31, 2026. For more: Overrides

excludes the override to request actual reported values from Jan 1, 2014 to the current date.

Headers:
DATE_TYPE, FA_ADJUSTED, and FA_PERIOD: show the default values for each option.

FIRMNAME: enter your Data License account number, provided by your Implementation Specialist.

DLWS (XML)

Field List (i.e., <ns:fields>): includes the <ns:value>E</ns:value> override to request historical and future estimates from Jan

Headers: <ns:date_type>, <ns:fa_adjusted>, and <ns:fa_period>: show the default values for each option.
For more: Request Headers.

Example Tech Estimates Data Request

XML
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://services.bloomberg.
2 <soapenv:Header/>
3 <soapenv:Body>
4 <ns:submitGetHistoryRequest>
5 <ns:headers>
6
7 <ns:daterange>
8
9 <ns:period>
10 <ns:start>2014-01-01</ns:start>
11 <ns:end>2026-05-31</ns:end>
12 </ns:period>
13 </ns:daterange>
14
15 <ns:programflag>adhoc</ns:programflag>
16 <ns:display_pricing_src>true</ns:display_pricing_src>
17 <ns:fa_adjusted>N</ns:fa_adjusted>
18 <ns:fa_period_type>Q</ns:fa_period_type>
19 <ns:date_type>periodend</ns:date_type>
20
21 </ns:headers>
22 <ns:fields>
23
24 <ns:field>SALES_REV_TURN</ns:field>
25
26 <ns:fieldWithOverrides>
27 <ns:id>SALES_REV_TURN</ns:id>
28 <ns:override>
29 <ns:key>AE</ns:key>
30 <ns:value>E</ns:value>
31 </ns:override>
32 </ns:fieldWithOverrides>
33
34 <ns:field>IS_OPER_INC</ns:field>
35
36 <ns:fieldWithOverrides>
37 <ns:id>IS_OPER_INC</ns:id>
38 <ns:override>
39 <ns:key>AE</ns:key>
40 <ns:value>E</ns:value>
41 </ns:override>
42 </ns:fieldWithOverrides>
43

Large-Cap Consumer Discretionary Company Fundamentals

You can gauge past performance for large cap consumer discretionary companies (i.e., retailers) with a single request.

The following example provides five years of quarterly, historical data (i.e., from Jan 1, 2019 to the current date) for the following fundamental metr

Revenue

Operating Income or Losses

Net Income/Net Profit (Losses)

Basic Earnings per Share

Diluted EPS

Gross Margin

Operating Margin

Price to Sales Ratio

Current Price to Free Cash Flow

Same Store Sales

Request actual, reported data for historical dates (i.e., from Jan 1, 2019 until the current date).

HINT
Note the following options within the request:
SFTP (Bash)
Field List (i.e., START-OF-FIELDS): does not include any overrides because the service returns A for actual reported data for Jan 1, 2014 u

Headers:

DATE_TYP, FA_ADJUSTED, and FA_PERIOD: show the default values for each option.

FIRMNAME: enter your Data License account number, provided by your Implementation Specialist.

DLWS (XML)

Field List (i.e., <ns:fields>): does not include any overrides because the service returns a for actual reported data for Jan 1, 2014 until t

Headers: <ns:date_type>, <ns:fa_adjusted>, and <ns:fa_period>: show the default values for each option.

For more: Request Headers.

Example Retail Fundamentals Data Request

XML

1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://services.bloomberg.

2 <soapenv:Header/>
3 <soapenv:Body>
4 <ns:submitGetHistoryRequest>
5 <ns:headers>
6
7 <ns:daterange>
8 <ns:period> 
Search...
9 <ns:start>2014-01-01</ns:start>
10 <ns:end>2026-05-31</ns:end>
11 </ns:period>
Introduction
12 </ns:daterange>
13
DATA <GO> and DL REST API
14 <ns:programflag>adhoc</ns:programflag>
15 and Web Services <ns:display_pricing_src>true</ns:display_pricing_src>
SFTP
16 <ns:fa_adjusted>N</ns:fa_adjusted>
17
Overview <ns:fa_period_type>Q</ns:fa_period_type>
18 <ns:date_type>reported</ns:date_type>
19 High Level Sequence Diagram
20 </ns:headers>
SFTP
21 <ns:fields>
22 SFTP via Internet
23 <ns:field>SALES_REV_TURN</ns:field>
24 SFTP via Dedicated<ns:Circuit
field>IS_OPER_INC</ns:field>
25 <ns:field>NET_INCOME</ns:field>
26 Setup for SFTP <ns:field>IS_EPS</ns:field>
27 <ns:field>IS_DILUTED_EPS</ns:field>
IP Addresses
28 <ns:field>GROSS_MARGIN</ns:field>
29 Legacy IP Addresses <ns:field>OPER_MARGIN</ns:field>
30 <ns:field>PX_TO_SALES_RATIO</ns:field>
Web Services
31 <ns:field>CURRENT_PX_TO_FREE_CASH_FLOW</ns:field>
32 <ns:field>SAME_STORE_SALES</ns:field>
33 Web Services Sample Code
34 Supported Platforms
</ns:fields>
35 <ns:instruments>
36 DLWS Certificate Manager
37 <ns:instrument>
38 Managing DLWS Certificates
<ns:id>WMT US Equity</ns:id>
39 </ns:instrument>
40 PKCS12 vs PEM
<ns:instrument>
41
Bloomberg Identifiers <ns:id>COST US Equity</ns:id>
42 </ns:instrument>
43
Best Practices <ns:instrument>

Limitations
Large-Cap Energy Company Fundamentals
Request Composition
You can gauge past performance for large cap energy (i.e., oil) companies with a single request.
Data Types
The following example Mode
Request Operation provides ten years of quarterly, historical data (i.e., from Jan 1, 2014 to the current date) for the following fundamental metr
Program Names
Revenue
getData
Operating Income or Losses
getHistory
NetgetTickHistory
Income/Net Profit (Losses)

getActions
Basic Earnings per Share
getcompany
Diluted EPS
getsnap
Gross Margin
getQuotes
Operating Margin
getAllQuotes

cancel
Price to Sales Ratio
cancel_all
Current Price to Free Cash Flow

Same Store Sales

scheduled 

Request Headers
Net Debt/EBITDA
Response Messages
Enterprise Value/EBITDAX
Links to a Bloomberg Terminal

Request
Request Builder
actual, reported data for historical dates (i.e., from Jan 1, 2019 until the current date).
Bulk Datasets

Cloud Delivery
HINT

Licensing
Note the following options within the request:
SFTP (Bash) 
Support
Field List (i.e., START-OF-FIELDS): does not include any overrides because the service returns A for actual reported data for Jan 1, 2014 u

Headers:

DATE_TYPE and FA_PERIOD: show the default values for each option.

FA_ADJUSTED: shows yes to request to request Bloomberg Enhanced Fundamentals data. Bloomberg Enhanced Fundamentals p

FIRMNAME: enter your Data License account number, provided by your Implementation Specialist.

DLWS (XML)

Field List (i.e., <ns:fields>): does not include any overrides because the service returns A for actual reported data for Jan 1, 2014 until t

Headers:

<ns:date_type> and <ns:fa_period>: show the default values for each option.

<ns:fa_adjusted>>: shows Y to request to request Bloomberg Enhanced Fundamentals data. Bloomberg Enhanced Fundamen

For more: Request Headers.

Example Energy Company Fundamental Data Request

XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://services.bloomberg.

<soapenv:Header/>
<soapenv:Body>
<ns:submitGetHistoryRequest>
<ns:headers>

<ns:daterange>
<ns:period>
<ns:start>2014-01-01</ns:start>
<ns:end>2026-05-31</ns:end>
</ns:period>
13 </ns:daterange>
14
15 <ns:programflag>adhoc</ns:programflag>
16 <ns:display_pricing_src>true</ns:display_pricing_src>
17 <ns:fa_adjusted>Y</ns:fa_adjusted>
18 <ns:fa_period_type>Q</ns:fa_period_type>
19 <ns:date_type>reported</ns:date_type>
20
21 </ns:headers>
22 <ns:fields>
23
24 <ns:field>SALES_REV_TURN</ns:field>
25 <ns:field>IS_OPER_INC</ns:field>
26 <ns:field>NET_INCOME</ns:field>
27 <ns:field>IS_EPS</ns:field>
28 <ns:field>IS_DILUTED_EPS</ns:field>
29 <ns:field>GROSS_MARGIN</ns:field>
30 <ns:field>OPER_MARGIN</ns:field>
31 <ns:field>PX_TO_SALES_RATIO</ns:field>
32 <ns:field>CURRENT_PX_TO_FREE_CASH_FLOW</ns:field>
33 <ns:field>NET_DEBT_TO_EBITDA</ns:field>
34 <ns:field>EV_TO_EBITDA</ns:field>
35
36 </ns:fields>
37 <ns:instruments>
38
39 <ns:instrument>
40 <ns:id>XOM US Equity</ns:id>
41 </ns:instrument>
42 <ns:instrument>
43 <ns:id>CVX US Equity</ns:id>

Return Codes
The following return codes are supported for getHistory:

Code Descriptions

0 Good return. No errors occurred.

-14 Field is not recognized or supported by the gethistory program. (1)

-13 Field, security, date range, or pricing source combination is not applicable. For example, PX_EVAL_LEGACY only applies for securitie

-12 Field is not available. (1)

-10 Start date > End date. (1)

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

123 You are not authorized for private loan (PRPL).

605 Permission for pricing source denied.

990 System Error. Contact Product Support and Technical Assistance.

992 Unknown override field.

994 You do not have permission (contractual) to download history for this security.

995 Maximum number of fields exceeded (i.e., 100 fundamental/industry-specific fields and 450 total fields). For more: Limitations.

996 Maximum number of data points exceeded (some data for this security is missing).
For getHistory requests that include one or more fundamental/industry-specific fields, the maximum is 1000 securities and 10 years
For horizontal format requests, the maximum is 60,000,000 data points.
For vertical format requests, the maximum is 30,000,000 data points.
For more: Limitations.

998 Security identifier type (e.g. CUSIP) is not recognized.

999 Unloadable security

Note:

(1) This return code is only applicable to the vertical output format.

If HIST_FORMAT=horizontal and the field requested is not available in getHistory, the field will return N.A..

Return Code Example 1: 1001 securities, 100 fundamentals/industry-specific fields, 10 years of data

The following truncated response is an example of the return codes for horizontal and vertical format requests that exceed the 1000 security limit.

Security Limit Return Codes (Horizontal Format)

BASH

Security Limit Return Codes (Vertical Format)

BASH

Return Code Example 2: 1001 securities, 200 pricing fields, 150 fundamentals/industry-specific fields, 10 years of data

The following truncated response is an example of the return codes for horizontal and vertical format requests that exceed the 100 fundamentals/

100 Fundamentals/Industry-Specific Field Limit (Horizontal Format)

BASH

1 ############################################################################
2 ## There were errors and/or warnings detected within the request file, please
3 ## correct and then resubmit the resulting file.
4 ##
5 ## Max limit of 1000 securities. Securities over the limit are indicated using RC=996.
6 ## Max limit of 100 Fundamentals, Estimates and FundamentalsIndustrySpecific fields. Rows over the limit are ind
7
8 start-of-fields
9 p1
10
10
11 f1
12 ...
13 p100
14 f100
15 p101
16 p102
17 ...
18 p200
19 end-of-fields
20
21 security1|995|100|date1|p1|f1|..|p100|f100|p101|p102|....|p200|
22 security2|995|100|date1|p1|f1|..|p100|f100|p101|p102|....|p200|
23 ....
24 security1000|995|100|date1|p1|f1|..|p100|f100|p101|p102|....|p200|
security1001|996|100||...|

100 Fundamentals/Industry-Specific Field Limit (Vertical Format)

BASH

Return Code Example 3: 100 securities, 200 pricing fields, 100 fundamentals/industry-specific fields, 25 years of data

The following truncated response is an example of the return codes for horizontal and vertical format requests that exceed the 10-year limit (i.e., Ja

10-Year Limit Return Codes (Horizontal Format)

BASH

1 ############################################################################
2 ## There were errors and/or warnings detected within the request file, please
3 ## correct and then resubmit the resulting file.
4 ##
5 ## Max limit of 10yrs of history. Securities over 10yrs are indicated using RC=996.
6
7 security1|0|300|20100101|p1|f1|..|p100|f100|p101|p102|....|p200|
8
8
...
9
security1|0|300|20191231|p1|f1|..|p100|f100|p101|p102|....|p200|
10
security1|996|300|..|
11
...
12
security2|0|300|20100101|p1|f1|..|p100|f100|p101|p102|....|p200|
13
security2|0|300|20191231|p1|f1|..|p100|f100|p101|p102|....|p200|
14
...
15
security2|996|300|..|
16
17
security100|0|300|20100101|p1|f1|..|p100|f100|p101|p102|....|p200|
18
security100|0|300|20191231|p1|f1|..|p100|f100|p101|p102|....|p200|
19
....
20
security100|996|300|..|

Security Limit Return Codes (Vertical Format)

BASH

getTickHistory
The tickhistory program provides access to historical intraday trades and/or quotes for multiple asset classes.

Features include:

Support for global equities, currencies, futures, options , swaps , GSAC fixed income bonds

Intraday tick data starting Jan 1st 2008 where available

Intraday GSAC fixed income bonds tick data starting Jan 1st 2013

Intraday Futures starting Jan 1st 2008 where available

High precision timestamps where available

Request trades or quotes or both depending on your use case

Strongly typed file formats

Coverage file included to validate row counts for both quotes and trades

The gettickhistory program has the following limits.

A maximum of 1 year of data PER request

Request should have a start date no earlier than Jan 1st 2008
All responses will always be compressed. The current SFTP limit for a file is 2 GB of data (20GB uncompressed)

For GSAC bonds, the following pricing sources are supported: BGN, CBBT, TRAC and Bloomberg’s MTF.

Tickers with reserved characters will have the characters removed in the output file NAME E.g. B/BF UN Equity will be converted to BBF UN

All timestamps are in UTC

US Options are available for the last 6 weeks.

Generic support for futures

Bloomberg supports generic ticker to access underlying futures data. This feature allows customers to request a generic ticker with a date range a

The syntax for generic tickers in the response file is as follows

Genericticker_Underlyingticker_quotes and Genericticker_Underlyingticker_trades

E.g.

Requesting ES1 Index and ES2 Index

gettickhistory_ES1 Index_ESH4 Index_quotes_1_1.csv

gettickhistory_ES1 Index_ESH4 Index_trades_1_1.csv
gettickhistory_ES2 Index_ESM4 Index_quotes_1_1.csv
gettickhistory_ES2 Index_ESM4 Index_trades_1_1.csv

Note: the tick data within the file will always be sourced from the underlying future and will be represented as such.

NOTE

For customers who want to use generic tickers to observe how futures roll from one contract to another; it’s recommended to request both the generic 1st and 2nd

HINT

For larger file limits, consider upgrading to Bloomberg’s Rest API and/or Cloud delivery.

Request Headers
For instructions on establishing a date and time range, selecting output format and type of data see the DATETIMERANGE, OUTPUT_MEDIA_TYPE

Notes:

All DateTime fields are in UTC for both request and response.

DATETIMERANGE ignores time zone in the headers and assumes UTC.

DATERANGE will use trade session for each security

SECDES_FIRST_COL: It’s always set to yes. If provided, it’s ignored.

DELIMITER: Always set to ‘,’. If provided, it’s ignored.

Responses from the program are in tar format with multiple files separated by security.

csv files are in always compressed format(csv.gz)

The COMPRESS request parameter for the gettickhistory will return file in .tar.gz format.

NOTE

DATERANGE will allow you to capture the entire day or date range ticks. DATETIMERANGE is used for request that require ticks in a specific time period during th
Responses may be decompressed using the Unix tool tar or WinZip on a PC.

Request Structure
Requests must follow this structure:

Start Tag: START-OF-FILE defines the beginning of a request.

Request Header: Contains information that identifies the customer, the type of request to run, the time to run the request, and other option

List of Securities: Can be populated with a list of individual securities.

End Tag: END-OF-FILE defines the end of the per security request file. It must be the last record in the request. If you do not contain this tag

Request Format
A valid call to the getickhistory program must include the appropriate header options, fields, and instruments for which you want to retrieve data.

Getting Started with SFTP > Header Descriptions

Getting Started with SFTP > Including Securities

Text

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=your_reply_file_name
PROGRAMNAME=gettickhistory
DATETIMERANGE=20220901_12:00:00|20220902_12:00:00
CONTENTTYPE=quotes&trades
OUTPUT_MEDIA_TYPE=application/x-tar;archive-media-type=gzip-csv
PROGRAM FLAG=adhoc
START-OF-DATA
IBM US Equity|TICKER
BBG014N13QC8|BB_GLOBAL
DD103619@TRAC Corp
BV876440@BGN Corp
BX922954@CBBT Corp
AXP US Equity
CMG US Equity
XOM US Equity
VOD LN Equity
NESN SW Equity
ROG SW Equity
CAP FP Equity
DBK GY Equity
EURUSD BGN Curncy|
VOD 2.95 02/19/2023 Corp|TICKER|1|PRICING_SOURCE|CBBT
VOD 2.95 02/19/2023 Corp|TICKER|1|PRICING_SOURCE|BGN
H4HD3Z Index
END-OF-DATA
END-OF-FILE

An output file will only be created if there is a valid request entered

The .tar extension will be added to the output file if it’s not provided in REPLYFILENAME

The COMPRESS flag generates a file with tar.gz extension

The .tar file contains multiple output files for each security broken out by trades and quotes

If any file is greater than 1GB, it will be partitioned into multiple file’s.

Within the .tar file, if a security has no data, you will not see an associated quote/trade file

All timestamps are in UTC

timestamps are in ISO Format in csv

File Format

tar file format(<requestfilename or replyfilename>.tar)

metadata

<request_file_name or REPLYFILENAME>_coverage.csv.gz

<request_file_name or REPLYFILENAME>_<security>_<override1Value>_…_<overrideNValue>_<trade/quotes>_<partition_number>_

Samples:

without overrides

tar -tvf msftticks.tar

> msftticks_MSFT US Equity_quotes_1_1.parquet
> msftticks_MSFT US Equity_trades_1_1.parquet
> metadata/msftticks_coverage.csv.gz

with Pricing Source overrides at security level.

tar -tvf eurcurncy.tar
> eurcurncy_EUR Curncy_CMPL_quotes_1_1.csv.gz
> eurcurncy_EUR Curncy_BGN_quotes_1_1.csv.gz
> metadata/eurcurncy_coverage.csv.gz

metadata file Format:

security, securityRc, tradesCount, quotesCount

Security

without overrides
security from request file.

with overrides at security level

security_override1_…_overrideN

securityRc -> Refer rcode documentation

tradesCount -> number of trades for security

quotesCount -> number of quotes for security

Samples:
security,securityRc,tradesCount,quotesCount
MSFT US Equituy,0,100,1302

with Pricing Source overrides at security level.

security,securityRc,tradesCount,quotesCount
EUR Curncy_CMPL,0,0,1302
EUR Curncy_BGN,0,0,1302

Trades Schema

Field Name

SECURITY

TICK_SEQUENCE_NUMBER

TICK_TYPE

EVT_TRADE_TIME
TRADE_REPORTED_TIME

EVT_TRADE_EXECUTION_TIME

EVT_TRADE_IDENTIFIER

EVENT_ORIGINAL_TRADE_ID

EVENT_ORIGINAL_TRADE_TIME

EVT_TRADE_PRICE

EVT_TRADE_SIZE

EVT_TRADE_LOCAL_EXCH_SOURCE

EVT_TRADE_CONDITION_CODE

EVT_TRADE_BUY_BROKER

EVT_TRADE_SELL_BROKER

TRACE_RPT_PARTY_SIDE_LAST_TRADE

EVT_TRADE_RPT_PARTY_TYP

EVT_TRADE_BIC

EVT_TRADE_MIC

EVT_TRADE_ESMA_TRADE_FLAGS

EVT_TRADE_AGGRESSOR

EVT_TRADE_RPT_CONTRA_TYP

EVT_TRADE_REMUNERATION

EVT_TRADE_ATS_INDICATOR

Quotes Schema

Field Name

SECURITY

TICK_SEQUENCE_NUMBER

TICK_TYPE

EVT_QUOTE_BID_TIME

EVT_QUOTE_BID_PRICE

EVT_QUOTE_BID_SIZE

EVT_QUOTE_BID_CONDITION_CODE

EVT_QUOTE_BID_LOCAL_EXCH_SRC

UPFRONT_QUOTED_BID_PRICE

EVT_QUOTE_ASK_TIME

EVT_QUOTE_ASK_PRICE

EVT_QUOTE_ASK_SIZE

EVT_QUOTE_ASK_CONDITION_CODE
EVT_QUOTE_ASK_LOCAL_EXCH_SRC

UPFRONT_QUOTED_ASK_PRICE

Excessive size error

To manage efficient delivery, Gettickhistory maintains a 2GB compressed (20GB uncompressed) limit for SFTP delivery. If a request breach

This error response file will have information about estimated size in MB for each security.

Clients can submit another request by further splitting the file by securities or by reducing the date range.

Response format:

<requestfilename or replyfilename.tar

<requestfilename or replyfilename>_out.err

e.g:

tar -tvf msftticks.tar

> metadata/msftticks_out.err

File schema:

security_name|error_code|estimated_quotes_size_in_MB|estimated_trades_size_in_MB

Sample Error File

Text

#############################################################################
## There were errors detected within the request file, please correct them
## and resubmit the resulting file.
##
## Source: your_dl_login_name
##
## The following errors were found:
##
## Estimated output size 3686.46 MB exceeds the allowed output size 2048.00 MB.
##
## Please reduce the request either by
## o Reducing the time range of the request.
## o Reducing the number of securities in the request.
##
## Please check the estimated output size for each security requested in Estimated Request File section below.
##
## Estimated Response File format is:
##
## security_name|error_code|estimated_quotes_size_in_MB|estimated_trades_size_in_MB
##
## Error Code Reference:
## o 0 valid security
## o ANY OTHER NUMBER invalid security
##
## Please consult the product documentation for more information on
## the error codes.
##
##
#############################################################################
## Estimated Request file:
#############################################################################
START-OF-FILE
FIRMNAME=your_dl_login_name
PROGRAMNAME=gettickhistory
DATETIMERANGE=2021-01-01_00:00:00|2022-01-05_23:59:59
CONTENTTYPE=quotes&trades
REPLYFILENAME=msftticks
OUTPUT_MEDIA_TYPE=application/x-tar;archive-media-type=gzip-csv
START-OF-DATA
MSFT US Equity|0|1463.19|2223.27
END-OF-DATA
END-OF-FILE

Return Codes

Code Description

0 Good return. No errors occurred.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

12 Invalid security identifier.

123 User not authorized for private loan (PRPL).

988 System error on security level.

989 Invalid pricing source.

990 System Error. Contact Product Support and Technical Assistance

994 Permission denied.

998 Security identifier type (e.g. CUSIP) is not recognized

999 System Error. Contact Product Support and Technical Assistance.

Sample Trade output file

CSV

1 SECURITY,TICK_SEQUENCE_NUMBER,TICK_TYPE,EVT_TRADE_TIME,TRADE_REPORTED_TIME,EVT_TRADE_EXECUTION_TIME,EVT_TRADE_ID
2 AAPL US Equity,51854,NEW,2022-01-12T13:50:00.866Z,2022-01-12T13:50:00.866Z,,m: -t:6320,,,176.420000,10,UQ,"FT,R6
3 AAPL US Equity,51855,NEW,2022-01-12T13:50:00.866Z,2022-01-12T13:50:00.866Z,,m: -t:6321,,,176.420000,1,UQ,"FT,R6,
4 AAPL US Equity,51856,NEW,2022-01-12T13:50:00.866Z,2022-01-12T13:50:00.866Z,,m: -t:1981,,,176.420000,10,VK,"FT,R6
5 AAPL US Equity,51862,NEW,2022-01-12T13:50:04.375Z,2022-01-12T13:50:04.375Z,,m: -t:4535,,,176.410000,4,UP,"FT,R6,
6 AAPL US Equity,51866,NEW,2022-01-12T13:50:06.014Z,2022-01-12T13:50:06.014Z,,m: -t:6322,,,176.430000,1,UQ,"FT,R6,
7 AAPL US Equity,51868,NEW,2022-01-12T13:50:08.545Z,2022-01-12T13:50:08.545Z,,m: -t:6323,,,176.430000,5,UQ,"FT,R6,
8 AAPL US Equity,51872,NEW,2022-01-12T13:50:09.559Z,2022-01-12T13:50:09.559Z,,m:Q-t:839,,,176.430000,2,UD,"FT,Q,OL
9 AAPL US Equity,51875,NEW,2022-01-12T13:50:10.006Z,2022-01-12T13:50:10.006Z,,m: -t:6324,,,176.430000,75,UQ,"FT,R6
10 AAPL US Equity,51877,NEW,2022-01-12T13:50:10.006Z,2022-01-12T13:50:10.006Z,,m: -t:6325,,,176.430000,75,UQ,"FT,R6
11 AAPL US Equity,51881,NEW,2022-01-12T13:50:10.006Z,2022-01-12T13:50:10.006Z,,m: -t:6326,,,176.430000,75,UQ,"FT,R6
12 AAPL US Equity,51888,NEW,2022-01-12T13:50:11.446Z,2022-01-12T13:50:11.446Z,,m: -t:6327,,,176.430000,8,UQ,"FT,R6,
13 AAPL US Equity,51889,NEW,2022-01-12T13:50:11.446Z,2022-01-12T13:50:11.446Z,,m: -t:6328,,,176.430000,61,UQ,"FT,R6
14 AAPL US Equity,51891,NEW,2022-01-12T13:50:11.446Z,2022-01-12T13:50:11.446Z,,m: -t:4536,,,176.430000,142,UP,"FT,R
15 AAPL US Equity,51894,NEW,2022-01-12T13:50:12.087Z,2022-01-12T13:50:12.087Z,,m: -t:4537,,,176.420000,1,UP,"FT,OL"
16 AAPL US Equity,51897,NEW,2022-01-12T13:50:12.573Z,2022-01-12T13:50:12.573Z,,m: -t:6329,,,176.420000,1,UQ,"FT,OL"
17 AAPL US Equity,51898,NEW,2022-01-12T13:50:12.596Z,2022-01-12T13:50:12.596Z,,m: -t:600,,,176.430000,1,UF,"FT,OL",
18 AAPL US Equity,51900,NEW,2022-01-12T13:50:13.296Z,2022-01-12T13:50:13.296Z,,m:N-t:171,,,176.439900,100,UD,"FT,N"
19 AAPL US Equity,51901,NEW,2022-01-12T13:50:13.454Z,2022-01-12T13:50:13.454Z,,m: -t:1982,,,176.430000,7,VK,"FT,OL"
20 AAPL US Equity,51910,NEW,2022-01-12T13:50:15.509Z,2022-01-12T13:50:15.509Z,,m: -t:6330,,,176.430000,1,UQ,"FT,OL"

Sample Quote output file

CSV

1 SECURITY,TICK_SEQUENCE_NUMBER,TICK_TYPE,EVT_QUOTE_BID_TIME,EVT_QUOTE_BID_PRICE,EVT_QUOTE_BID_SIZE,EVT_QUOTE_BID_
2 AAPL US Equity,51859,BID,2022-01-12T13:50:01.095Z,176.410000,1,,UP,,,,,,,
3 AAPL US Equity,51863,BID,2022-01-12T13:50:04.375Z,176.400000,1,,UF,,,,,,,
4 AAPL US Equity,51867,ASK,,,,,,,2022-01-12T13:50:06.014Z,176.430000,2,,UQ,
5 AAPL US Equity,51876,ASK,,,,,,,2022-01-12T13:50:10.006Z,176.430000,1,,UQ,
6 AAPL US Equity,51880,ASK,,,,,,,2022-01-12T13:50:10.006Z,176.440000,5,,UQ,
7 AAPL US Equity,51883,ASK,,,,,,,2022-01-12T13:50:10.007Z,176.430000,1,,UP,
8 AAPL US Equity,51886,BID,2022-01-12T13:50:10.866Z,176.400000,6,,VK,,,,,,,
9
10 AAPL US Equity,51892,ASK,,,,,,,2022-01-12T13:50:11.446Z,176.440000,5,,UQ,
11 AAPL US Equity,51908,BID,2022-01-12T13:50:15.466Z,176.420000,1,,UQ,,,,,,,
12 AAPL US Equity,51911,BID,2022-01-12T13:50:15.509Z,176.400000,6,,VK,,,,,,,
13 AAPL US Equity,51917,ASK,,,,,,,2022-01-12T13:50:15.893Z,176.480000,4,,VG,
14 AAPL US Equity,51922,BID,2022-01-12T13:50:17.036Z,176.420000,1,,UQ,,,,,,,
15 AAPL US Equity,51926,BID,2022-01-12T13:50:18.011Z,176.440000,1,,UF,,,,,,,
16 AAPL US Equity,51930,BID,2022-01-12T13:50:18.617Z,176.440000,1,,UP,,,,,,,
17 AAPL US Equity,51932,ASK,,,,,,,2022-01-12T13:50:18.944Z,176.470000,1,,VK,
18 AAPL US Equity,51957,BID,2022-01-12T13:50:19.224Z,176.410000,1,,UP,,,,,,,
19 AAPL US Equity,51961,BID,2022-01-12T13:50:19.224Z,176.400000,6,,VK,,,,,,,
20 AAPL US Equity,51983,ASK,,,,,,,2022-01-12T13:50:22.513Z,176.450000,1,,UF,
AAPL US Equity,51986,ASK,,,,,,,2022-01-12T13:50:22.513Z,176.470000,1,,VK,

Compressed Parquet files

Compressed CSV files

getActions
For each security in the request, the getactions program returns corporate actions that apply to that security and its issuer.

For example, specifying IBM US Equity in a getActions request returns actions specific to that common stock (e.g., a cash dividend) as well as act

Format:

<Identifier> | <Bloomberg Company ID > | <Bloomberg Security ID> |

Field Description

Identifier The security identifier used in the request.

Bloomberg Company ID A number that uniquely identifies a company.

Bloomberg Security ID A number that in combination with Bloomberg Company ID identifies a security.

Rcode The return code.

Action ID A unique action identifier assigned to corporate actions.

An update or delete of an action will have the same Action ID as the initial entry of th

Mnemonic The mnemonic for corporate action.

Field Description

Flag The status of the action at the moment of the request. Returns N for an action that has
Note 1: You should load actions with the first appearance of an Action ID whether the
Note 2: If D is returned as a Flag, CP_DELETE_REASON is provided as the only non-st
Note 3: If an action appears for the first time with a D flag, you should not load the ac

Company Name The name of the company.

SecID type The type of security ID.

For Bonds: CUSIP, ISIN, BBID , BB_UNIQUE
For Equities: CUSIP, ISIN, VALOREN, SEDOL, BELGIAN, WPK, SICOVAM, FONDS, BB_U
The system returns the first available identifier type within this hierarchy.

SecID The security ID.

Currency The currency of the security (ISO code).

Market Sector Description The name of the market sector yellow key on the Bloomberg Terminal that the securit

Bloomberg Unique ID A unique number assigned by Bloomberg to all securities.

Ann-date The date when the corporate action is announced.

Eff-date The date when the corporate action becomes effective.

The field returns a value of N.A. for the following actions when they are in To Be Anno

Amd-date The date when the corporate action was updated. Valid only when Flag is U, otherwis

Bloomberg Global ID A unique global identifier assigned by Bloomberg for all securities across asset classe

Bloomberg Global Company ID The Bloomberg global identifier (BBGID) for the company level entity.

Bloomberg Security ID Number A unique Bloomberg name for all Bloomberg securities on a given yellow key.

Feed Source The market data source field for the B-Pipe feed. Designed to work with Bloomberg S

Nfields The number of fields.

fld-mnemo1…fld-mnemoN The mnemonic identifying data elements 1 to N.

Value-1…Value-Nfields The data element 1 to N.

Header Parameters
The ACTIONS_DATE header parameter is essential:

By default, Bloomberg matches the securities in the request with corporate actions that were entered into the Bloomberg database in the 2

The ACTIONS_DATE parameter can also modify whether the response returns actions based on effective date, entry date, or both. Actions tha

Additional options are available to control action types and date ranges:

ACTIONS: Specifies action types or action categories. This line cannot be more than 254 characters in length and cannot exceed 128 specifi

DATERANGE: Allows you to retrieve actions (based on entry date, effective date, or both) up to a maximum of seven days prior to the reque

Corporate Action Categories

Corporate Actions are divided into four categories, outlined below. The Corporate Actions Layout provides a list of all corporate actions that fall un

For the fields returned for each action type, see the dataset corporate_actions_layout.xlsx in the Notices folder in your home directory

For all possible returns for each corporate action field, see the dataset lookup.out located in the root folder of your Data License SFTP acco
Action Category codes C and S indicate whether an action is a (S) ecurity level action or a (C) ompany/Issuer level action.

Action Category

CORPORATE_EVENTS

Corporate Action

Name Change

Equity Delisting

Shareholder Meeting

Domicile Change

Change in Listing

Fiscal Year End Change

State of Incorporation Change

Equity Listing

Round Lot Change

Currency Quotation Change

Fund Objective Change

Ticker Symbol Change

Reconvention

Warrant Terms Change

ID Number Change

Redenomination

CAPITAL_CHANGE

Corporate Action

Spin-off

Divestiture

Funged Issues

Bankruptcy Filing

Installment Call – Partial Pay

Extendible Issues

Stock Buyback

Reclassification

Default Corp Action

Corporate Action

Equity Offering

Debt Repurchase

Default Resolution

Debt Redemption Call

Debt Redemption/Put

Defeased Bond Update

Debt Offering/Increase

Exchange Offers

Equity Redemption

Debt Offering/New

Variable Principal Redemption

Debt Repurch/Open Mkt

Par Value Change

Pay in Kind

Consent Solicitation

Debt Redemption Sinker

Rights Offering

Acquisition

Conversion Price Refix

DISTRIBUTIONS

Corporate Action

Cash Dividends

Stock Dividend

Stock Split

MUNIS

Corporate Action

Muni Bankruptcy Filing

Muni Default Settlement

Muni Redemption/Sinking Fund

Muni Bond Holder Meeting

Muni LOC Substitution

Muni Redemption/Put

Muni Default
Corporate Action

Muni Redemption/Call

Muni Refunding

Return codes
The following return codes are supported for getActions:

Code Description

0 Good return. No errors occurred.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

123 User not authorized for private loan (PRPL).

300 No corporate actions were found for given security.

400 Corporate actions are not applicable for requested security (e.g., CMO)

990 System Error. Contact Product Support and Technical Assistance.

994 Permission denied.

995 Maximum number of fields exceeded.

996 Maximum number of data points exceeded (some data for this security is missing)

998 Security identifier type (e.g., CUSIP) is not recognized.

999 Unloadable security

Example getActions Request

Text

## Sample request file

# Note:
# - `PROGRAMFLAG` was not specified in request, so that `PROGRAMFLAG` is
# defaulted to `oneshot` by the 'Data License' service.

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=TestActions.out
# Looking for Ticker Changes on the specified securities
ACTIONS=CHG_TKR
# Returning actions based on BOTH entry and effective dates
ACTIONS_DATE=both
DATERANGE=20130315|20130322
PROGRAMNAME=getactions
START-OF-DATA
# Three equities and one unknown security
# The two below securities had actions within this date range
MIH PM Equity
LPH US Equity
# A return code of 300 indicates there is no corporate action for this security
IBM Equity
# A return code of 10 indicates that Bloomberg did not recognize the security
Fake Equity
END-OF-DATA
END-OF-FILE
## Sample reply file
### Note that each corporate action is returned as one record. There are also no empty lines between corporate ac

START-OF-FILE

PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
REPLYFILENAME=TestActions.out
# Looking for Ticker Changes on the specified securities
ACTIONS=CHG_TKR
# Returning actions based on BOTH entry and effective dates
ACTIONS_DATE=both
DATERANGE=20130315|20130322
PROGRAMNAME=getactions

TIMESTARTED=Fri Mar 22 11:09:56 EDT 2013

getcompany
This program returns company/entity level data such as industry classification, country of risk, and country of domicile for a given security/compan

The program supports requests by security/ticker or by entity/company ID. This program requires the inclusion of header option CREDITRISK=Yes

Format:

|<Identifier>|<Rcode> | <Nfields> | <Value-1> | <Value-2> |...| <Value-Nfields>|

Field

Identifier

Rcode

Nfields

Value-1 … Value-Nfields

Return Codes
The following return codes are supported for getcompany:

Code Description

0 Good return. No errors occurred.

11 Security found, but no associated company

12 Bloomberg cannot find the security and the identifier syntax/format is incorrect

123 User not authorized for private loan (PRPL)

988 System Error on security level

990 System Error. Contact Product Support and Technical Assistance.

994 Permission denied (Contact DL Sales Rep)

995 Maximum number of fields exceeded

996 Maximum number of data points exceeded (some data for this security is missing)

998 Security identifier type (e.g., CUSIP) is not recognized.

999 Unloadable security

Sample request and reply for getcompany request using a security/ticker.

Text
## Sample getcompany **Request** file using Security
# Note:
# `PROGRAMFLAG` was not specified in request, so that `PROGRAMFLAG` is
# defaulted to `oneshot` by the 'Data License' service

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=getcompanytest.out
PROGRAMNAME=getcompany

START-OF-FIELDS
ID_BB_COMPANY
CNTRY_OF_RISK
IS_ULT_PARENT
END-OF-FIELDS

START-OF-DATA
IBM US Equity
END-OF-DATA
END-OF-FILE
## Sample getcompany **Reply** file using Security

START-OF-FILE
PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
REPLYFILENAME=getcompanytest.out
CREDITRISK=yes
PROGRAMNAME=getcompany

START-OF-FIELDS
ID_BB_COMPANY
CNTRY_OF_RISK
IS_ULT_PARENT
END-OF-FIELDS

TIMESTARTED=Mon May 18 13:03:45 EST 2009

START-OF-DATA
IBM US Equity|0|3|100801|US|Y|
END-OF-DATA
TIMEFINISHED=Mon May 18 13:03:47 EST 2009
DATARECORDS=1
END-OF-FILE

Sample request and reply for getcompany request using a company ID.

Text

## Sample getcompany Request file using Company

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=getcompany_id_bb.out
SECID=BB_COMPANY
PROGRAMNAME=getcompany

START-OF-FIELDS
ID_BB_COMPANY
LONG_COMP_NAME
CNTRY_OF_RISK
IS_ULT_PARENT
END-OF-FIELDS

START-OF-DATA
100801
END-OF-DATA
END-OF-FILE
## Sample getcompany **Reply** file using Company

START-OF-FILE
RUNDATE=20090518
PROGRAMFLAG=oneshot
FIRMNAME=your_dl_login_name
REPLYFILENAME=getcompany_id_bb.out
CREDITRISK=yes
SECID=BB_COMPANY
PROGRAMNAME=getcompany

START-OF-FIELDS
ID_BB_COMPANY
LONG_COMP_NAME
CNTRY_OF_RISK
IS_ULT_PARENT
END-OF-FIELDS

TIMESTARTED=Mon May 18 13:20:12 EST 2009

START-OF-DATA
100801|0|4|100801|International Business Machines
Corp|US|Y|
END-OF-DATA

getsnap
getsnap offers a service to address clients who need an asset price returned at a more precise time or at the time of valuation point. getsnap is av

The Snapshot service also supports reference data requests (in Security Master Category) in addition to pricing data. The getsnap program return

Specific Program Requirements

Requests must be submitted at least 30 minutes prior to the selected snap time. Snaps can be requested every 15 minutes. Clients will receive a re

Specific Header Options

SNAPTIME specifies the time the snap should be executed. SNAPTIME expects a time value of the form HHMM, where HH=00-23 adn MM=00-59. .

Field

Identifier

Rcode

Nfields

OPEN PRICE … PRICING SOURCE

## Users may append this information with any Security Master field by adding them to the field section of request. For e

START-OF-FIELDS
SETTLE_DT
END-OF-FIELDS

Return codes
The following return codes are currently supported for getsnap:

Code Description

0 Good return. No errors occurred.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

16 Security not processed

100 Maximum number of securities exceeded (40,000)

150 Security blocked due to embargo not being met

Code Description

988 System Error on security level

989 Unrecognized pricing source

990 System Error Contact Product Support and Technical Assistance.

991 Invalid override value (e.g., bad date or number)

992 Unknown override field

993 Maximum number of overrides (20) exceeded

994 Permission denied.

995 Maximum number of fields exceeded.

996 Maximum number of data points exceeded (some data for this security is missing)

997 General override error (e.g., formatting error)

998 Security identifier type (e.g., CUSIP) is not recognized.

999 Unloadable security

Sample getsnap request / response and reply files.

Note: The data flow of getsnap request differs from the other Per Security programs:

1. After request was accepted by Data License the response is delivered with no delay

2. And at the time specified by SNAPTIME the actual reply is delivered

The following sample contains samples of all that: 1. request 2. response 3. and reply.

Sample getsnap request / response and reply files.

Text

## Sample request file

# Note:
# `PROGRAMFLAG` was not specified in request, so that `PROGRAMFLAG` is
# defaulted to `oneshot` by the 'Data License' service

START-OF-FILE
FIRMNAME=dlxxxxx
REPLYFILENAME=testgetsnap
SNAPTIME=0900
DELAY_LIMIT=3
COLUMNHEADER=yes
PROGRAMNAME=getsnap

START-OF-FIELDS
MARKET_SECTOR_DES
END-OF-FIELDS

START-OF-DATA
BMW GY Equity
IBM US Equity
AHA LN 03/18/11 C2600 Equity
GB0033280339|ISIN|
CH0114507210 Corp
EQ0017443700001000|BB_UNIQUE|
END-OF-DATA
END-OF-FILE
## Sample response file

START-OF-FILE
REQUESTFILENAME=testgetsnap.req
PROGRAMFLAG=oneshot
FIRMNAME=dlxxxxx
REPLYFILENAME=testgetsnap
SNAPTIME=0900
DELAY_LIMIT=3
COLUMNHEADER=yes
PROGRAMNAME=getsnap

START-OF-FIELDS
ID_BB_UNIQUE
ID_BB_GLOBAL
END-OF-FIELDS

getQuotes
The getQuotes program returns every last execution price time stamped with date, hour, minute, and second.

getQuotes has the following limits:

You may request a maximum of three (3) consecutive days of tick data in a single request.

A maximum of 240 trading days of tick data is available, provided the security has been priced for that amount of time.

There is a limit of 20 million individual ticks per response. When this limit is reached, the response truncates at the previous full record and

Notes:

getQuotes ignores any fields specified between the keywords START-OF-FIELDS and END-OF-FIELDS.

The first data point forgetQuotes is the most recent tick, followed by older ticks.

getQuotes can be used in conjunction with Security Wildcards.

Responses forgetQuotes are always compressed. (The COMPRESS request parameter forgetQuotes is ignored.) Responses may be decom

For instructions on establishing a date and time range, see DATERANGE and DATETIMERANGE. Many data points can potentially be return

Format:

START SECURITY | <Identifier>|<Exchange Code>|

Identifier is displayed if the SECDES_FIRST_COL header parameter is set to yes(the default is no).

Field

Identifier

Month-1/Day-1…Month-N/Day-N

Time-1…Time-N

Price-1…Price-N

Volume-1…Volume-N

Tick Code-1…Tick Code-N

Condition code-1…Condition code-N

Return Codes
The following return codes are supported for getQuotes:

Code Description

0 Good return. No errors occurred.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

12 Invalid security identifier.

123 You are not authorized for private loan (PRPL).

600 Error retrieving tick data.

601 There are no ticks available for this security on the date range requested.

602 Security not found in tick database.

603 Error retrieving tick data.

604 Invalid dates specified.

605 Permission for pricing source denied.

606 Tick limit has been exceeded.

988 System error on security level

989 Invalid pricing source

990 System Error. Contact Product Support and Technical Assistance.

994 Permission denied.

995 Maximum number of fields exceeded.

996 Maximum number of data points exceeded (some data for this security is missing)

998 Security identifier type (e.g., CUSIP) is not recognized.

999 System Error. Contact Product Support and Technical Assistance.

getQuotes Example

Text

## Sample request file

START-OF-FILE
FIRMNAME=your_dl_login_name
REPLYFILENAME=getquotes_reply.out
DATERANGE=20090320|20090320
PROGRAMNAME=getquotes
PROGRAMFLAG=adhoc
START-OF-DATA
EDPR PL Equity
END-OF-DATA
END-OF-FILE
## Sample reply file

RUNDATE=20180521
FIRMNAME=your_dl_login_name
REPLYFILENAME=getquotes_reply.out
DATERANGE=20180517|20180517
PROGRAMNAME=getquotes
PROGRAMFLAG=adhoc

TIMESTARTED=Mon May 21 11:23:53 EDT 2018

START-OF-DATA
START SECURITY|EDPR PL Equity|PL|
## in: 20180517 to 20180517 [13 (New York-DST)]
## out:20180517_00:00:00 to 20180517_23:59:59 [13 (New York-DST)]
05/17|11:35:11|8.22|2008|L|CA|
05/17|11:35:11|8.22|310|L|CA|
05/17|11:35:11|8.22|1228|L|CA|
...
05/17|01:51:05|8.07|2|L|T|
05/17|01:50:55|8.07|2|L|T|
05/17|01:50:05|8.07|2|L|T|
END SECURITY|EDPR PL Equity|0|
END-OF-DATA
TIMEFINISHED=Mon May 21 11:23:54 EDT 2018
DATARECORDS=1
END-OF-FILE

getAllQuotes
The getAllQuotes program is similar to the getQuotes program, except that in addition to returning every last execution price, matching ask and

getAllQuotes has the following limits:

You may request a maximum of three (3) consecutive days of tick data in a single request.

A maximum of 240 trading days of tick data is available, provided the security has been priced for that amount of time.

There is a limit of 20 million individual ticks per response. When this limit is reached, the response truncates at the previous full record and w

getAllQuotes is available for all security types for which Bloomberg has tick data.

Note:

Responses forgetAllQuotes are always compressed. (The COMPRESS request parameter forgetAllQuotes is ignored.) Responses may be

For instructions on establishing a date and time range, see DATERANGE and DATETIMERANGE. Many data points can potentially be return

Format for bid and ask ticks:

START SECURITY | <Identifier>|Exchange Code|

MATCHGETTICKSCOLS=yes merges MarketMaker and Exchange/Source Columns.

Field

Identifier

Month-1/Day-1…Month-N/Day-N

TimeB-1…TimeB-N

TypeB-1…TypeB-N

PriceB-1…PriceB-N

Tick CodeB-1…Tick CodeB-N

VolumeB-1…VolumeB-N

TypeA-1…TypeA-N

PriceA-1…PriceA-N

Tick CodeA-1…Tick CodeA-N

Field

MarketMakerB-1…MarketMakerB-N

MarketMakerA-1…MarketMakerA-N

Exchange/Source CodeB-1…Exchange/Source Code B-N

Exchange/Source CodeA-1…Exchange/Source Code A-N

VolumeA-1…VolumeA-N

Condition code-1…Condition code-N

Format for trade ticks:

START SECURITY | <Identifier>

Field

Identifier

Month-1/Day-1…Month-N/Day-N

Time-1…Time-N

TypeT-1…TypeT-N

Price-1…Price-N

MarketMaker-1…MarketMaker-N

Tick Code-1…Tick Code-N

Volume-1….Volume-N

Condition code-1…Condition code-N

Return Codes
The following return codes are supported for getAllQuotes:

Code Description

0 Good return. No errors occurred.

10 Bloomberg cannot find the security as specified.

11 Restricted Security.

12 Invalid security identifier.

123 You are not authorized for private loan (PRPL).

600 Error retrieving tick data.

Code Description

601 There are no ticks available for this security on the date range requested.

602 Security not found in tick database.

603 Error retrieving tick data.

604 Invalid dates specified.

605 Permission for pricing source denied.

606 Tick limit has been exceeded.

988 System error on security level

989 Invalid pricing source

990 System Error. Contact Product Support and Technical Assistance.

994 Permission denied.

995 Maximum number of fields exceeded.

996 Maximum number of data points exceeded (some data for this security is missing)

998 Security identifier type (e.g., CUSIP) is not recognized.

999 System Error. Contact Product Support and Technical Assistance.

getAllQuotes Example

Text

## Sample request

START-OF-FILE
FIRMNAME=your_dl_login_name
COMPRESS=yes
REPLYFILENAME=getallquotes.out
DATERANGE=20090320|20090320
PROGRAMNAME=getallquotes
PROGRAMFLAG=adhoc
START-OF-DATA
EDPR PL Equity
END-OF-DATA
END-OF-FILE
## Sample reply

START-OF-FILE
RUNDATE=20090320
FIRMNAME=your_dl_login_name
COMPRESS=yes
REPLYFILENAME=getallquotes.out
DATERANGE=20090320|20090320
PROGRAMNAME=getallquotes
PROGRAMFLAG=adhoc
TIMESTARTED=Fri Mar 20 12:52:48 EDT 2009
START-OF-DATA
START SECURITY|EDPR PL Equity|PL|
## in: 20090320 to 20090320 [13 (New York-DST)]
## out:20090320_00:00:00 to 20090320_23:59:59 [13 (New York-DST)]
03/20|12:39:32|B|6.15|L|4300|A|6.168|L|1307||
03/20|12:37:24|B|6.15|L|820|A|6.168|L|1307||
03/20|12:35:55|B|6.15|L|4300|A|6.168|L|1307||
03/20|12:35:22|B|6.15|L|3480|A|6.168|L|1307||
03/20|12:35:22|B|6.145|L|9309|A|6.168|L|1307||
03/20|12:35:04|B|6.15|L|23480|A|6.168|L|1307||
03/20|12:35:04|T|6.15|L|6715|AU|
03/20|12:35:04|T|6.15|L|1000|AU|
03/20|12:35:04|T|6.15|L|1500|AU|
03/20|12:35:04|T|6.15|L|2500|AU|
03/20|12:35:04|T|6.15|L|5000|AU|

END SECURITY|EDPR PL Equity|0|

END-OF-DATA

Header Parameters

cancel
This program cancels a scheduled request.

Note:

One-shot requests cannot be cancelled.

Adhoc requests cannot be cancelled.

To cancel a scheduled request, submit a cancel request with REPLYFILENAME equal to that of the scheduled response as specified within the subm

Examples:

In order to cancel a daily scheduled request called “stocks”, a cancel request with REPLYFILENAME=stocks would need to be submitted.

In order to cancel a daily scheduled request called “bonds.dat”, a cancel request with REPLYFILENAME=bonds.dat would need to be subm

## For example, to cancel a daily scheduled job that returns data in the response: corps.out
START-OF-FILE
FIRMNAME=dlxxxxx
REPLYFILENAME=corps.out
PROGRAMFLAG=daily
PROGRAMNAME=cancel

END-OF-FILE

cancel_all
This program can be used to cancel multiple (a list of) or all currently scheduled requests.

Note:

One-shot requests cannot be cancelled.

Adhoc requests cannot be cancelled.

The reply name of each individual scheduled request, which is to be cancelled, must be listed between START-OF-DATA and END-OF-DATA of the c

## For example, following is a sample 'cancel_all' request to cancel scheduled requests named: ABC.out, DEF and GHI.out.g

START-OF-FILE
FIRMNAME=dlxxxxx
PROGRAMNAME=cancel_all
PROGRAMFLAG=daily

START-OF-DATA
ABC.out
DEF
GHI.out.gz
END-OF-DATA

END-OF-FILE

## sample 'cancel_all' reply

START-OF-FILE
RUNDATE=20180525
REPLYFILENAME=cancel_sample.out

FIRMNAME=dlxxxxx
PROGRAMNAME=cancel_all
PROGRAMFLAG=daily

END-OF-FILE

scheduled
This program returns a report containing all recurrent requests that are currently scheduled. The response contains all the currently active requests

Scheduled requests:

include only header parameters; not securities and data sections

always processed as a oneshot request

If there are no scheduled requests found under the account (of any frequency), the response No scheduled nightly requests found. returns.

Example Scheduled Reports Request

Text

START-OF-FILE
FIRMNAME=dl123456
REPLYFILENAME=scheduled.out
PROGRAMNAME=scheduled
END-OF-FILE

Editing Scheduled Requests

To edit securities or fields in a scheduled request, you must send another request, listing new securities or fields under the same REPLYFILENAME a

Request Headers
The following table contains header options you can use to configure persSecurity requests. You must enter header options in your requests as up

Note: The header section in the reply can differ from the per security request header and can be changed by Bloomberg without notice.

Header Option Supported Programs Default

ACTIONS getactions all

ACTIONS_DATE getactions entry

BVALSNAPSHOT getdata No default

BVALSNAPSHOTDATE getdata No default

BVALTIER getdata 2

BVALBETA getdata, gethistory no

COLUMNHEADER5 getdata, getsnap, getcompany no

COMPRESS5 All programs yes/no4

CONTENTTYPE gettickhistory No default

DATEFORMAT5 getactions, getdata, gethistory, getsnap, getcompany mmddyyyy

DATERANGE All programs (except getdata, gettickhistory and getsnap) No default

DATETIMERANGE getquotes, getallquotes and gettickhistory No default

DATE_TYPE gethistory PERIODEND

DELAY_LIMIT getsnap 0

DELIMITER5 getdata, getcompany, getsnap Unix pipe (|) cha

DIFFFLAG getdata no

DISPLAY_PRICING_SRC gethistory no

DISPLAYQRMDATE getquotes, getallquotes no

DLP_SUBSCRIBERS6 getdata, getcompany This DL+ heade

ENCODING getdata ASCII

EXCLUSIVE_PRICING_SRC getdata, gethistory, getsnap no

FA_ADJUSTED gethistory no

FA_PERIOD_TYPE gethistory P

FILETYPE5 All programs unix

FIRMNAME5 All programs No default

HEADER5 All programs (except scheduled) yes

HIST_CRNCY getdata, gethistory No default

HIST_FORMAT gethistory vertical

HIST_PERIOD gethistory Smallest period

HIST_OPTION gethistory No default

MATCHgetticksCOLS getallquotes no

OUTPUTFORMAT5 getdata, getsnap variable

OUTPUT_MEDIA_TYPE gettickhistory variable

PORTSECDES All programs (except scheduled, cancel, cancel_all) No default

PRICING_SOURCE5 getdata, gethistory, getsnap No default

PROGRAMFLAG5 All programs (except scheduled)3 oneshot

PROGRAMNAME5 All programs getdata

PRP (deprecated) All programs (except scheduled and getsnap) No default

REPLYFILENAME5 All programs Default is reque

RUNDATE All programs Today2

SECDES_FIRST_COL getquotes, getallquotes no

SECDESLENGTH5 getdata, getsnap 30 if OUTPUTFO

SECID5 All programs (except scheduled, cancel, cancel_all) No default1

SKIP_PCS getdata, gethistory No default

SN All programs No default

SNAPTIME getsnap No default

SOURCE_OVERRIDE6 getdata, getcompany This DL+ heade

SPECIALCHAR getdata, getsnap Decimal

TICKADJUSTDATE getquotes, getallquotes, getticks, getallticks no

TICKEXCHLENGTH getquotes, getallquotes, getticks, getallticks 1

TICKFILTER getquotes, getallquotes legacy

TICKLOCALZTZ getticks, getallticks 1

TICKOUTPUTTZ getquotes, getallquotes Account time zo

TIME All programs (except getsnap, cancel, cancel_all, scheduled) immediate (AD

UPLOADTYPE Customupload No default

USERNUMBER All programs No default

VERSION All programs (except scheduled) old

WARNINGS getcompany, getquotes, getallquotes yes

WORKSHEET All programs No default

YELLOWKEY All programs (except scheduled, cancel, cancel_all) No default

1
For SFTP requests, the default is request.out, where request is the request name without the .req extension.
2 The current date means the date for the time zone currently used by your DL account (that is, the time zone might differ from your local time zon
3 If PROGRAMFLAG is set to adhoc, then the requests are processed immediately and the TIME parameter is ignored
4
The default value of COMPRESS is either yes or no depending on the PROGRAMNAME parameter value.
5 Also available in DL+.
6
Only available for DL+.

ACTIONS
Allows you to filter corporate actions responses by requesting only certain actions or categories of actions.

For example, you can request a single action type such as Acquisitions. You can also request a category of actions along with a single action from a

Note: These lines cannot be more than 254 characters in length and cannot exceed 128 specific actions.

ACTIONS_DATE
Allows you to request corporate actions based on different dates. You can set it to one of the following values:

Value Description

entry(default value) The date the corporate action was entered into the Bloomberg database. If you do not include a DATERA

effective The effective date of the corporate action, which can be up to two years in the future. If you do not includ

Note: The response to future date requests contains only those actions available at the time of the reque

both Incorporates both the entry and effective dates for corporate actions.

BVALBETA
Returns BVAL beta prices. It can be set to either yes or no (default).

COLUMNHEADER
If the following is set: COLUMNHEADER=yes, then the following row appears above the data:

If the following is set:

DELIMITER=,
COLUMNHEADER=yes

Then the following row appears above the data:

<Identifier>,<Rcode>,<Nfields>,PX_BID,PX_MID,PX_ASK

If set to yes, the response returns the title of each column of data. For example, if you request the fields PX_BID, PX_MID, and PX_ASK, they appear

If you set DELIMITER to change the |, then there is no trailing delimiter.

COMPRESS
Returns the requested data file compressed by the Unix tool gzip. You can decompress the file using gunzip or Winzip.

DATEFORMAT
Customizes the format of dates produced in the reply files. Optional formats are listed in the table below.

Note: Only applicable to the getactions, getdata, gethistory, getsnap, and getcompany programs.

Format (in the request file)

mmddyy

yyddmm

ddmmyy

yyyyddmm

yyyymmdd

yymmdd

mmddyyyy

yyyy/mm/dd

dd-mmm-yy

ddmmyyyy

mmyydd

ddyymm

mmyyyydd

ddyyyymm

DATERANGE
Specifies a certain date range for data produced by the getquotes, getallquotes, getactions, and gethistory programs. You can specify either an in

Note: For getactions, you can request a maximum of 7 days prior to the request date.

Integer number of days example:

DATERANGE=r

Where r is an integer specifying the number of calendar days (not business days) from the current day. For example, the setting DATERANGE=1 retu

DATERANGE=1
ARSUSD Curncy|0|2|01/11/2021|0.2536|

ARSUSD Curncy|0|2|01/12/2021|0.2535|

The DATERANGE is set in Eastern Time (ET) for gethistory and getactions. For other Program Names, DATERANGE is set according to the time zone of

Setting DATERANGE=0 returns the date from only today:

DATERANGE=0

ARSUSD Curncy|0|2|01/12/2021|0.2535|

Explicit date range example:

DATERANGE=date1|date2

date1 is the start date in the format yyyymmdd.

date2 is the end date in the format yyyymmdd.

DATERANGE=20200102|20210102

The programs gethistory, getquotes, and getallquotes support DATERANGE for individual securities, using the same date format as shown above. Th

Format:

<Security Identifier>||<date1>|<date2>|

IBM US Equity||20200102|20201231|

DATETIMERANGE
Specifies a certain date and time range for data produced by the getquotes, getallquotes and gettickhistory programs. This option:

Is limited to a single calendar day (i.e., 00:00-23:59).

Implies dates are in the format yyyymmdd.

Implies times are in the format hh:mm:ss.

Implies region name is set appropriately to the region of securities exchange.

region name and region code will be ignored for gettickhistory

Time is always treated as UTC for gettickhistory

DATETIMERANGE and DATERANGE are mutually exclusive header parameters

The two possible uses of this header option are as follows:

Region Name:

DATETIMERANGE=date1_time1|date2_time2|region name

Region name takes the format XX with the supported values NY (New York), LO (London), and TO (Tokyo). For example:

DATETIMERANGE=20210109_07:00:00|20210109_15:30:00|NY

Region Code:

DATETIMERANGE=date1_time1|date2_time2|region code

Region code is in the TZDF <GO> format on the Bloomberg Terminal® or listed in the Time Zone Reference Codes section.

DATETIMERANGE=20210109_07:00:00|20210109_15:30:00|3

There is an optional parameter to account for Daylight Savings Time (DST) in the DATETIMERANGE header option. Appending /DST or /NODST adjus

DATETIMERANGE=date1_time1|date2_time2|region name/NODST

DATETIMERANGE=date1_time1|date2_time2|region name/DST

DATETIMERANGE=date1_time1|date2_time2|region code/NODST

DATETIMERANGE=date1_time1|date2_time2|region code/DST

Time Zone Reference Numbers

Reference time zone numbers for the optional header DATETIMERANGE are listed in the table below:

Time Zone Reference No. Ex

1 E

2 M

3 H

4 A

5 Pa

6 M

7 A

8 M

9 C

10 S

11 In

12 B

13 E

14 S

15 C

16 A

17 N

18 B

19 B

20 M

21 A

22 Lo

23 G

24 B

25 A

26 E

27 H

28 Is

29 C

30 K

31 M

32 Te

33 A

34 K
Time Zone Reference No. Ex

35 Is

36 M

37 D

38 A

39 B

40 B

41 H

42 To

43 A

44 D

45 C

46 B

47 H

48 M

49 K

50 W

51 F

DATE_TYPE
Allows you to request either the date at which the company actually reported the value for the corresponding field (i.e., REPORTED) or the end date

DELAY_LIMIT
Allows you to impose additional controls on a request file containing securities with mixed embargo times. For example, DELAY_LIMIT=30 returns

DELIMITER
Allows the specification of the delimiter you want to use. You can use any single ASCII character except " (double quote) and a blank. The default

Setting

DELIMITER=,

DELIMITER=#$

If a DELIMITER is specified and it is not a | (Unix pipe character):

All text fields are surrounded with double quotes. Applicable to the getdata, getcompany, and getsnap programs.

The SECDESLENGTH parameter cuts two symbols more from the security description, because two places are taken by quotes.

DIFFFLAG
Controls the Bloomberg output sent back to you. Applicable only to scheduled recurring requests using the getdata program (see the PROGRAM
Value Description

no All output (unmodified) is sent to you.

yes The response contains the output of the Unix diff utility. In cases where something has changed, this diff provides full records from the previous respons

Smaller The output is compared against the most recently generated data using the Unix diff utility, and the smaller of the two datasets (the current response an

changes As with the yes option, the Unix diff utility compares the previous response to the current response. In this case, the response sent to you contains only

Example request header:

Python

1 START-OF-FILE
2 RUNDATE=dl123456
3 REPLYFILENAME=difftest.out
4 DIFFFLAG=ch
5 PROGRAMNAME=getdataanges
6 PROGRAMFLAG=weekday

In responses, the DIFFFLAG line is returned between TIMESTARTED and START-OF-DATA.

Example output file:

Python

1 TIMESTARTED=Mon May 18 11:48:52 EDT 2020

2 DIFFFLAG=changes
3 START-OF-DATA
4 IBM US Equity|0|3|INTL BUSINESS MACHINES
5 CORP|1613.321|.740|
6 MSFT US Equity|0|3|MICROSOFT CORP|10804.354|3.320|
7 INTC US Equity|0|3|INTEL CORP|6173.000|.240|
8 END-OF-DATA
9 TIMEFINISHED=Mon May 18 11:48:53 EDT 2020
10 END-OF_FILE

Bloomberg does not recommend the use of DIFFFLAG; rather, the use of snapshots is recommended for the following reasons:

DIFFFLAG values support diverse usage of the Unix diff utility, which compares files line by line, but there is no “un-difference” facility, and t

Snapshots are required in any case for differences to be meaningful.

Creating new states B, C, … is quicker and simpler by consuming snapshots.

DISPLAY_PRICING_SRC
Available for corporate, preferred, government, municipal, and mortgage securities. If you use this option, the PRICING_SOURCE is returned in the o

DISPLAYQRMDATE
Controls the date for each tick. Set to yes, the date mirrors the trade dates in the Trade/Quote Recap (QR <GO> and QRM <GO>) functions on the

DLP_SUBSCRIBERS (DL+ only)

This DL+ header requests consumer-specific data based on named subscribers and associated field lists defined in the DL+ Workstation. Use a pip

For more: Managing Subscribers in DL+.

ENCODING
Controls the output encoding. It can be set to either ASCII (default) or UTF-8. If you set the value of this option to ASCII, then the US-ASCII standa

Example of decoding the datasets using Python:

Python

1 outfile = 'test.out' # test.out is the outfile name

2 f = open(outfile, encoding="ascii") # Decode using US-ASCII standard
3 f = open(outfile, encoding="utf-8") # Decode using UTF-8 standard

EXCLUSIVE_PRICING_SRC
Applies to bonds. Allows you to designate an exclusive pricing source when using a PRICING_SOURCE override. If the exclusive source is not availa

The following override formats are supported for EXCLUSIVE_PRICING_SRC=yes:

Header option: PRICING_SOURCE=Header Option

Security level overrides: 123456789 Corp||1|PRICING_SOURCE|ABCD|

Below are sample request and output files that illustrate the PRICING_SOURCE= header option:

Request file example:

Python

1 START-OF-FILE
2 FIRMNAME=dl123456
3 REPLYFILENAME=epsheader.out
4 PROGRAMNAME=getdata
5 PRICING_SOURCE=BGN
6 EXCLUSIVE_PRICING_SRC=yes
7 START-OF-FIELDS
8 PX_LAST
9 PRICING_SOURCE
10 END-OF-FIELDS
11 START-OF-DATA
12 CT30 Govt
13 END-OF-DATA
14 END-OF-FILE

Output file example:

Python

1 START-OF-FILE
2 RUNDATE=20081003
3 PROGRAMFLAG=oneshot
4 FIRMNAME=dl123456
5 REPLYFILENAME=epsheader.out
6 PROGRAMNAME=getdata
7 PRICING_SOURCE=BGN
8 EXCLUSIVE_PRICING_SRC=yes
9 START-OF-FIELDS
10 PX_LAST
11 PRICING_SOURCE
12 END-OF-FIELDS
13 TIMESTARTED=Fri Oct 3 09:33:20 EDT 2008
14 START-OF-DATA
15 CT30 Govt|0|2|103.206971|BGN|
16 END-OF-DATA
17
17 TIMEFINISHED=Fri Oct 3 09:33:26 EDT 2008
18 END-OF-FILE

Request file using security-level override:

Python

1 START-OF-FILE
2 FIRMNAME=dl123456
3 REPLYFILENAME=epssec.out
4 PROGRAMNAME=getdata
5 EXCLUSIVE_PRICING_SRC=yes
6 START-OF-FIELDS
7 PX_LAST
8 PRICING_SOURCE
9 END-OF-FIELDS
10 START-OF-DATA
11 CT30 Govt||1|PRICING_SOURCE|BGN|
12 END-OF-DATA
13 END-OF-FILE

Output file using security-level override:

Python

1 START-OF-FILE
2 RUNDATE=20081003
3 PROGRAMFLAG=oneshot
4 FIRMNAME=dl123456
5 REPLYFILENAME=epsnoticesec.out
6 PROGRAMNAME=getdata
7 EXCLUSIVE_PRICING_SRC=yes
8 START-OF-FIELDS
9 PX_LAST
10 PRICING_SOURCE
11 END-OF-FIELDS
12 START-OF-DATA
13 CT30 Govt|0|2|103.206971|BGN|
14 END-OF-DATA
15 END-OF-FILE

FA_ADJUSTED
Allows you to request either Bloomberg Enhanced Fundamentals (yes) or Generally Accepted Accounting Principles (no) data.

Bloomberg Enhanced Fundamentals: Since and including fiscal year 2009, Bloomberg data experts analyzed the financial reporting for all current

In addition, Bloomberg makes non-GAAP adjustments to the income statement to remove the impact of one-time and other abnormal charges.

FA_PERIOD_TYPE
The periodicity for the fundamental data you request, such as:

Quarterly (Q)

Semi Annually (S)

Annually (A)

Last Twelve Months (L)

Primary Periodicity (P)

The primary periodicity (P) is the primary periodicity the corresponding company uses to report financials. To identify the periodicity for a given co

FIRMNAME
The SFTP login name assigned by Bloomberg. If you send an SFTP request file with an incorrect FIRMNAME, it is returned as an error. The FIRMNAME

HEADER
Allows you to specify if the header should be returned in the response. You can set this option to yes, no, or timeonly, where yes is the default.

If you specify HEADER=no, only the data between START-OF-DATA and END-OF-DATA is returned.

If you specify HEADER=no and COLUMNHEADER=yes, the first line of the response is SECURITIES|ERROR CODE|NUM FLDS|.

If you specify HEADER=timeonly, the TIMESTARTED and TIMEFINISHED lines are included in the response.

HIST_CRNCY
Allows you to specify the currency for history requests. You can use it in your getdata and gethistory programs requests for historical data. You can

HIST_FORMAT
Alters the output format of a gethistory request. The default vertical format separates the data by the field requested and appears vertically. In the

HIST_OPTION
Allows users of the gethistory program to retrieve historical averages (arithmetic mean) for the date range and period you specify. The only valid v

HIST_PERIOD
Sets the periodicity of gethistory requests. The default behavior provides the smallest period available for the data requested. Data is provided on

Periodicity Code

MATCHGETTICKSCOLS
Controls the output layout for the getallquotes program. If set to yes, the output format (columns) matches getallticks.

OUTPUTFORMAT
Controls the format of responses. Options include:

Option Description

bulklist Applies to bulk fields only in the getdata program. When this is specified, each entry in the bulk field is listed, one per line. This option w

fixed Separates each column without using a delimiter. It is based solely on spacing.

variable The default. Field information is returned separated by the specified delimiter or the default Unix pipe sign (|). Fields are returned with th
Note: If you set OUTPUTFORMAT to fixed, then the fields delimiter is bypassed in the reply file.

PORTSECDES
Specifies the way in which the security description is returned in the response when you use a portfolio feature in the Portfolio Administration (PRT

PRICING_SOURCE
Specifies a PRICING_SOURCE override rather than overriding an individual PRICING_SOURCE in a request. This override applies to all corporate,

Fixed Income

BGN

EXCH

BVAL*

*
Data License accounts that are not subscribed to the BVAL service can only access a subset of BVAL data where the price is wholly derived from d

You can specify the pricing source at the security level using the following format:

912828DM9 Govt||1|PRICING_SOURCE|BGN|

The PRICING_SOURCE override works with fixed income securities (preferred, government, or corporate) and mortgage securities in the getdata a

Rather than overriding the PRICING_SOURCE field, the proper format for overriding a currency pricing provider is:

<TICKER> <currency source code> Curncy

For example, if you subscribe to ABC Company pricing on the Bloomberg Terminal® (provider code XXXX), the following is used to download ABC

EUR XXXX Curncy

Currency pricing provider codes appear in the Foreign Exchange Defaults (XDF <GO>) function on the Terminal.

Similarly, the default setting for futures is PIT (day) session if you are not linked to a specific Terminal user. Linking refers to the Commodity Default

Example of setting the session to ELEC:

CLA ELEC Comdty

Futures exchange session settings can be found in the Commodity Defaults (CDEF <GO>) function on the Terminal.

PROGRAMFLAG
Determines how often to process the request. If you do not specify this option, the default is oneshot. The release time of data gathered by the sta

Adhoc mode allows you to run a request one time immediately upon submission. Release of data is subject to a minimum delay of 50 seconds. If y

PROGRAMFLAG Description

adhoc Specifies that the request runs one time only. The request starts imme

Scheduled mode allows you to schedule a per security request for a particular date and time. For that purpose, additional RUNDATE and TIME varia

Take into account that:

RUNDATE defaults to the current date.

TIME defaults to 00:00.

The table below describes the different use cases for the TIME and RUNDATE variables.

TIME Variable RUNDATE Variable

Not defined Not defined

TIME Variable RUNDATE Variable

00:00 Not defined

04:00 Not defined

03:10 Not defined

Not defined 2020.05.25

The TIME and RUNDATE variables are set according to the time zone of the account’s sales region, i.e., New York (NY), London (LO), or Tokyo (TO).

The scheduled mode provides several delivery behaviors defined by the PROGRAMFLAG header option:

PROGRAMFLAG Description

oneshot Specifies that the request runs one time only.

daily Specifies that the request starts daily at a certain time.

weekly Specifies that the request starts weekly on the same day of the week on which the initial request was submitted. Yo

monthly Specifies that the request starts monthly on the same day of the month on which the initial request was submitted.

weekday Specifies that the request starts on Monday through Friday only. You can use this option in conjunction with the TIM

weekend Specifies that the request starts on Saturday and Sunday only. You can use this option in conjunction with the TIME

The programs supported vary according to the mode as shown in the following table:

Program Name

getdata

gethistory

gettickhistory

getallquotes

getactions

getcompany

getsnap

cancel

cancel_all

scheduled

* The program’s delivery mode is always implied to be adhoc (that is, the PROGRAMFLAG is ignored). Reply delivery timeout intervals depend on the

PROGRAMNAME
Specifies the program to run, e.g., getdata, gethistory. For a complete list of available programs, see Program Names in the Running Programs sec

PRP
This field is deprecated. The Portfolio Report (PRP) setup number was formerly found on the Bloomberg Terminal® at the PRP <GO> function.
REPLYFILENAME
Specifies the name of the dataset created to contain the response to a data request. The reply filename is a string that:

Should not exceed 25 characters for SFTP.

Should contain only allowed characters listed below.

Should not have a .req extension; any other is extension allowed.

Should not coincide with file names of delivered bulk files.

The allowed filename characters include the following ASCII characters:

From a to z (lowercase)

From A to Z (uppercase)

Decimal digit symbols – 0-9

The following symbols: ‘+’,’-‘,’.’,’^’,’_’

You can use the following regular expressions to determine if user input contains any invalid characters (not allowed in REPLYFILENAME):

[^a-zA-Z0-9+-.^_]

If not specified, REPLYFILENAME defaults to the request filename with .out as the extension in place of .req for SFTP. For example, a request file ca

If a reply file’s name contains the any not allowed characters, or ends in either .req or .req.enc, the request file will be moved to the request

If a reply file name is the same as a file run earlier in the day, the new file would have the name with a number appended to the file name.

For example, a repeat request of:

abc.out.20090511

Results in a version number appended as follows:

abc.out.20090511.1

RUNDATE
Controls the date on which requests are processed. For requests scheduled with a frequency made available under the PROGRAMFLAG option, R

For example, to start a request on June 30, 2020, set

RUNDATE=20200630

You can use this option in conjunction with the TIME or SNAPTIME option. If no TIME is specified, the response starts at 00:00 of the date specified

The RUNDATE is based on the time zone of the region associated with the Data License account; there are three account regions: NY, LO, and TO.

SECDES_FIRST_COL
Applicable to the getquotes and getallquotes programs. Controls whether the ticker/identifier is printed next to each tick (SECDES_FIRST_COL=yes

SECDESLENGTH
Allows you to specify the length of the security description in the response. The security description is the first data column that is returned. Valid v

Security description length of 8 characters:

SECDESLENGTH=8

This results in usage of the maximum supported length of 32 characters:

SECDESLENGTH=100

If the SECDESLENGTH parameter is used together with the DELIMITER parameter, then the output is influenced by both.
SECID
Allows the specification of a default security identifier. If you specify an alternate security identifier for a security, this option is ignored for that secu

In the example below, TICKER and SEDOL are assigned as alternate identifiers; the remaining numbers will process as ISIN:

Python

1 SECID=ISIN
2 ...
3
4 START-OF-DATA
5 US4592001014
6 US8855351040
7 CT30 Govt|TICKER|
8 2346070|SEDOL|
9 DE0005245500
10 JP3592200004
11 ...
12
13 END-OF-DATA

The security identifier must be one of the following:

AUSTRIAN

BELGIUM

COMMON_NUMBER

EUROCLEAR

ISRAELI

SEDOL

WPK (Wertpapier Kenn-nummer)

If the wrong SECID parameter is specified, the response contains return code 10 (for security not found).

For example, if an ISIN was incorrectly identified as a sedol:

JP3592200004|SEDOL

The response would return:

JP3592200004|10|...

If requesting Equity securities by their CUSIP identifiers, it must be specified that CUSIP is the identifier being used. By way of example, the CUSIP

In a request, one of the following formats must be used for the security to be recognized for processing:

459200101|CUSIP

459200101 Equity|CUSIP

When requesting by TICKER, the market sector must be specified. When both SECID= and YELLOWKEY= options are specified, the SECID= option ta

The length of a security identifier cannot exceed 32 characters. Therefore, the YELLOWKEY (whether included in the START-OF-DATA section of the r

For example: IBM US Equity = 13 characters. You should not include SECID in the security identifier count:

Notes:

It is possible to request Money Market data using <six digit cusip> M-mkt. For example, 4381ZA.

ISINs are not supported as identifier types to be used to pull data for derivatives.

SKIP_PCS
Allows you to define one or more pricing sources that you would like to skip when determining the pricing source returned for a given security’s p

The syntax for the header option is:

SKIP_PCS=BGN

For more than one source, separate with a Unix pipe character (|):

SKIP_PCS=BGN|EXCH

SN and WS
The serial number (SN) and workstation number (WS) of the Bloomberg Terminal®. Each is available to allow you to link your Terminal to take advan

SNAPTIME
Specifies the time the snapshot should be executed. The format should be hh00 or hh30, where hh is in military time (0-23). The request file must b

Notes:

The snaptime is based on the time zone of the region associated with the Data License account; there are three account regions: NY, LO, an

This parameter has no default value.

This parameter is required if either PROGRAMNAME=getsnap or PROGRAMNAME=cancelsnap.

SOURCE_OVERRIDE (DL+ only)

For getData and getCompany requests, allows you to indicate whether you want to request data from your Data License Per Security (DLPS) accou

Option Description

DLPS The response provides the latest available data content from an Adhoc mode or Scheduled mode DLPS request. Adhoc requests incur a pre

DLPLUS The response provides data content from the modeled DL+ universe as of the DL+ Delivery Schedule. For more: Scheduled Runs.

NOTE

The response provides content from your DLPS account if your DLPLUS account does not contain the securities and fields for a sufficient

SPECIALCHAR
Controls the output of fractional and decimal fields. Fractional characters can occur in price fields and security descriptions. SPECIALCHAR default

Option Description

bloomberg Use Bloomberg’s special characters where appropriate, e.g., one half is represented as a byte containing 0x9f.

fraction Translate Bloomberg’s special characters to ASCII fractions, e.g., one half is represented as 1/2.

decimal:n Translate Bloomberg’s special characters to ASCII decimals; e.g., one half is represented as .5. You can specify the number of decimal places using

Certain fields return security descriptions, such as SECURITY_DES for corporate bonds. Security descriptions may contain “fraction characters,” whic

TICKADJUSTDATE
If a session ends on the following day due to time zone conversions (e.g., some Asian securities), this option automatically adjusts the requested ti
TICKEXCHLENGTH
Controls the length of the exchange code and can be set to either 1 or 2. The default is a single-character exchange code. Using TICKEXCHLENGTH

TICKFILTER
Filters the returned ticks and has the values below (defaults to legacy).

Value Description

legacy The data matches the QR <GO> or QRM <GO> screen.

su43 Ticks with certain condition codes are filtered out.

TICKLOCALTZ
The default for this option is no, and the default time zone is New York. With TICKLOCALTZ=yes in a request, the time zone setting of the client profi

On a request basis, you can link in your TZDF profiles via the USERNUMBER option.

On an account basis, you can contact Product Support and Technical Assistance to request that a particular UUID is associated with your account. T

TICKOUTPUTTZ and TICKLOCALTZ are mutually exclusive header options.

TICKOUTPUTFORMAT
Alters the output format to match those of older programs. It is mutually exclusive with the MATCHGETTICKSCOLS header option, only applies to

Value Description

ticks Output matches that of the getticks/getallticks program.

quotes Output matches that of the getquotes/getallquotes program

quotesbo Output matches that of bulk quotes datasets.

TICKOUTPUTTZ
Determines the time zone of the response dataset. This setting is independent of the region selected in the DATERANGE and DATETIMERANGE h

By default, ticks are returned in the same time zone as they are requested. TICKOUTPUTTZ overrides the region in the DATETIMERANGE setting.

DATETIMERANGE controls the time zone of the input, and TICKOUTPUTTZ controls the time zone of the output.

For example, you can request to download ticks from 09:00:00 to 17:00:00 New York time and have the output displayed in London time. The hea

DATETIMERANGE=20210109_09:00:00|20210109_17:00:00|NY

TICKOUTPUTTZ=LO (or TICKOUTPUTTZ=22)

There is an optional parameter to account for Daylight Savings Time (DST) in the TICKOUTPUTTZ header option. Appending /NODST or /DST adjus

Examples with NODST and DST:

TICKOUTPUTTZ=50/NODST

TICKOUTPUTTZ=50/DST

TIME
Determines the time at which requests are processed.

If TIME is not specified in a request, it is processed immediately. The format is TIME=HHMM, where HH is the hour (00 – 23) and MM is the minute (00

During daylight savings time transitions, requests are processed either at the scheduled time or when the time has passed, whichever comes earli

If the TIME parameter is not used in a scheduled request, the request will immediately process at the time the request is received by Bloomberg, a
The TIME will be set according to the time zone of the account’s sales region, New York (NY), London (LO), or Tokyo (TO).

UPLOADTYPE
Specifies how the request should be processed. It is only applicable to the CUSTOMUPLOAD program and has the values listed below.

Value

mars

bvalotc

bvalmmkt

USERNUMBER
The user number of the Bloomberg Terminal® login. It allows you to link your personal Terminal defaults (e.g., fixed income pricing sources) to a lo

VERSION
Specifies the software version. If you specify new, the new beta version of the software processes the request. A new beta version is typically availa

WARNINGS
Emits warnings related to the processing of the request, if any, to the response dataset. It can be set to either yes (default) or no.

YELLOWKEY
Specifies a default market sector (i.e., Govt, Corp, Equity, etc.) that will be used with the security descriptions. The market sector must be part of th

Govt

Corp

Mtge

M-Mkt

Muni

Pfd

Equity

Comdty

Index

Curncy

If a market sector description is already appended to the security in the data section, the given value for this option will be ignored. For example:

Python

1 YELLOWKEY=Equity
2
3 START-OF-DATA
4 IBM US|| # Load as IBM US Equity
5 CT30 Govt|| # Load as CT30 Govt as YK=Govt is explicitly specified
6
7
MSFT US|| # Load as MSFT US Equity
END-OF-DATA

When both SECID= and YELLOWKEY= options are specified, the SECID= option takes precedence. Both options have the same rules regarding leng

The length of a security identifier cannot exceed 32 characters. Therefore, the YELLOWKEY (whether included in the START-OF-DATA section of the

For example: IBM US Equity equals 13 characters. Bloomberg does not include SECID header parameter in the security identifier count.

Response Messages

Response Charset
The basic response datasets for the different programs that can be requested via PROGRAMNAME include the following allowable characters:

Encoding: Printable ASCII characters only.

Exclusions: Binary characters or special escape sequences.

End of Line: DOS files, which contain an additional carriage return are accepted.

Delimiter Character: Unix pipe sign (|).

Response file names cannot contain the following characters:

`~!@#$%&*()[],{}:;‘”></?|=

White spaces are also not allowed in response file names.

Response Naming Conventions

The following are rules and best practices for response names and their media types:

You can use the REPLYFILENAME option in the header section of the request to specify the name and media type of your response.

If REPLYFILENAME is not specified, the default is .out where is the name of the request excluding the .req extension.

If REPLYFILENAME is specified in the header, that value is used as is, and the .out media type is not added automatically. For example, if REP

The response name must not end in .req or .req.enc.

If the response is compressed, it has .gz appended to the name. Bloomberg always compresses the responses for the gethistory, getquotes, and g

For other programs, e.g., getdata, by default the COMPRESS header is set to no. If compression is desired, the request header COMPRESS=yes mus

Encrypted responses do not have the .enc media type even when they are encrypted. The only time .enc should appear is on the input (request si

Bloomberg always provides a datestamped version and a non-datestamped version of responses. The non-datestamped version represents the m

<rundate> is of the form of YYYYMMDD, where YYYY is the four-digit year, MM is the two-digit month and DD is the two-digit day.

Response Format
Responses have the general format shown below. Both the header and field sections are exactly as specified in the submitted request. Lines that w

TIMESTARTED
The date and time the request began processing on Bloomberg’s backend server. The format is the same as the output of the UNIX date comman

For example, a request that started processing on May 21, 2021 at 11:43:56 EDT returns
TIMESTARTED=Thu May 21 11:43:56 EDT 2021.

DIFFFLAG
Only valid for the responses of recurrent scheduled diff requests (that is, except oneshot and adhoc requests).
TIMEFINISHED
The date and time the request finished processing on Bloomberg’s backend server. The format of TIMEFINISHED is the same as TIMESTARTED:

TIMEFINISHED=Thu May 21 11:46:51 EDT 2021

Response Availability
A response dataset is available as a file on the primary and backup SFTP servers for seven (7) days after the initial request. You must maintain a bac

When the Bloomberg backend server uploads a response to the client, a copy of it is kept, appended with the date it was sent. For example, a resp

The correct way to utilize Data License internet SFTP servers is to pull the date-stamped response. Internet servers have a failure recovery round-ro

Each SFTP server has a backup server. In the event the primary server is unavailable, you can place requests on the backup server. All responses a

Compression
The Unix utility gzip is used to compress files. Files loaded into a Unix platform can be decompressed with the Unix gzip utility. Files loaded into a

Links to a Bloomberg Terminal

Clients whose firms subscribe to the BLOOMBERG PROFESSIONAL service have the option of linking their data license account to their BLOOMB

To link to a terminal, the following lines need to be added to the request header:

USERNUMBER=
WS=
SN=

Users can locate the numbers needed above by entering {IAM} on the BLOOMBERG PROFESSIONAL service. The following information appears:

User: 5555555 S/N 532374-5

Which should be read as follows

Header User String Position or Value

USERNUMBER The integer number before S/N which is 5555555 in this example

SN The integer number after S/N, but preceding the hyphen, which is

WS Always set this header to 0, even if IAM shows a different value (e.

If linking to a BBA (Bloomberg Anywhere) terminal, only the USERNUMBER should be included in the header of the request. Including SN and WS cou

Linking your Data License requests to a Bloomberg Terminal which has been cancelled or moved may impact data in the response. Users should b

Troubleshooting
If the Bloomberg Terminal is permanently linked to the Data License account and becomes cancelled, users should contact Customer Support imm

If a Bloomberg terminal is moved/relocated users should ensure any links to it are still valid. For example, relocating an Open Bloomberg Termina

If user receives the following return in your response, please contact your account representative for assistance:

SN and/or user number not in the same firm as dlxxxxxx

Request Builder

Overview
The Data License Request Builder is a stand-alone Java application that you can run on various operating system desktops. Request Builder is one

Request Builder
Request Builder:

Simplifies the creation of Data License request files and organizes the large number of available options in a user-friendly, non-technical GU

Supports SFTP as well as Send File (through the Bloomberg Professional® Service) for Data License.

SFTP Client
The SFTP Client:

Simplifies the transferring of files to and from Bloomberg SFTP servers.

Retrieves and submits files manually or automatically using this application’s scheduling capability.

Decompresses and decrypts transferred files automatically.

Capable of completely automating the transferring of files offline.

NOTE

The SFTP Client is an alternative to applications such as CuteFTP and WSFTP that require licenses and fees.

API Package
The API Package provides useful Java classes and methods for the Java programming language. This package is used by all of the other applicatio

Prior Knowledge
Bloomberg recommends basic knowledge of the Data License Per Security product prior to using these applications. For more: Bloomberg Data L

Install Request Builder

You can download and set up Request Builder to create, submit, retrieve, and decrypt Data License request files to and from the SFTP servers with

Installation Prerequisites
Before you can begin the Request Builder installation, you must complete the following steps:

A. Verify that You Are Running the Appropriate Operating System. Request Builder version 7.1.3 is supported on these operating systems:

Microsoft Windows 10 and 11

Windows Server 2016 and 2019

B. Download the Request Builder Install Package. The install package consists of an .exe file to guide your installation. For more: Customer Se

C. Back Up Your Login Credentials. If you have an existing Request Builder installation, you must download your available login credentials be
D. Back Up and Import Scheduled Jobs: If you have an existing Request Builder installation, you can back up your existing Scheduled Jobs an

1. Back up your scheduled jobs:

a. Select Settings > FTP File Scheduler to open the FTP File Scheduler.

b. Select File > Save Data As

c. Save the file as bbdlstps.xml

d. Open the file and ensure it is not empty.

2. Import your scheduled jobs:

a. Select Settings > FTP File Scheduler to open the FTP File Scheduler.

b. Press CRTL+SHIFT+I
A prompt appears to import schedule files.

c. Select your bbdlftps.xml file.

d. Close and reopen the Request Builder.

e. Check the FTP Scheduler and confirm that Scheduled Jobs appear.

E. Install Java 8 Development Kit (JDK): Before you install Request Builder v7.1.3, you must install a 64-bit or 32-bit version of the JRE or JDK.

NOTE

The Request Builder does not support versions higher than Java 8 (e.g., 11, 21, and 23).

You may need assistance from your IT administration department, depending on the authorization level you have on your machine.

1. Download Java 8 JRE or JDK from your preferred vendor.

2. Run the Java Installer and note where Java is installed. Each vendor’s Installer shows the default installation directory. You can install t

3. Enter CMD to open a command prompt window, then select Run as administrator.

4. From the java.security file in the \lib\security subdirectory of the JRE installation directory, uncomment the crypto.policy=un

5. Set the environment variables exactly as shown in code font:

a. Enter SET javapath=

b. Enter SET java8path=

c. Enter SET JAVA_TOOL_OPTIONS="-Dos.name=Windows 7"

d. Ensure the Java installation bin directory is the first item in the path (i.e., ECHO %PATH%).

6. Run the installation code from the same command prompt.

a. Navigate to the directory where the rb7-1-3.exe download is located.

b. Run rb7-1-3.exe

Installation Process
When you run rb7-1-3.exe, a series of dialogs appear. Follow the prompts to complete the Request Builder 7.1.3 installation process.

1. From the Introduction, click the Next button.

2. From the License Agreement, select I accept the terms of the License Agreement > Next.

3. From Choose Install Folder, click Next.

4. From Choose Link Folder, select In an existing Program Group > Bloomberg > Next.

5. From Choose Java Virtual Machine, select C:\Program Files\Java\jdk1.8.0_311\bin\java.exe > Next.

HINT

Choose the same Java environment that you set in the PATH when performing the JDK or JRE installation steps above.

6. From Install Complete, click the Done button.

Installation Troubleshooting
The following sections provide troubleshooting instructions for specific errors and scenarios.

Error Summary

You cannot install Java.

Common Causes

You do not have administrative permissions for Windows settings.

Troubleshooting

1. Locate the directory for the existing Java installation on your machine, e.g., C:\Program Files\Java\'version'\bin OR C:\Program Fil

2. Enter CMD to open a command prompt.

3. To set your environment, at the C:\ prompt. enter SET PATH=C:\Program Files\Java\jdk1.8.0_431\bin\

4. Run the installation from the same command prompt.

a. Navigate to the directory for the rb7-1-3.exe download.

b. Run rb7-1-3.exe

Error Summary

You cannot install the Data License Request Builder or Java.

Common Causes

Your operating system is not Microsoft Windows 10, Windows 11, Windows Server 2016, or Windows Server 2019.

Troubleshooting

1. Enter CMD to open a command prompt.

2. At the C:\ prompt, enter SET JAVA_TOOL_OPTIONS="-Dos.name=Windows 7" exactly as shown here in code font.

3. Set your environment:

a. Enter PATH.
The current directory appears.

b. Copy the current directory to a text file.

c. Remove all references to java from the directory except for 32-bit JAVA_HOME/bin, e.g., C:\Program Files (x86)\Java\jre1.8.0

4. Run the installation from the same command prompt:

a. Navigate to the directory for the rb7-1-3.exe download.

b. Optional: If you want to support multiple Java installations on the same machine, reinstate the original PATH that you saved in step 3.

c. Run RequestBuilder.exe

Error Summary

Windows error 2 occurred while loading the Java VM.

Common Causes

The application you try to open requires a username and password to run. For more: appuals.com > Fix: Windows Error 2 Occurred While Loading

Troubleshooting

Remove javapath from your environment variables and retry the installation.

Uninstall Request Builder

You can uninstall the Data License Request Builder if you want to install a new version or simply remove it from your machine.

NOTE

To ensure the installation runs, you must set the JAVA_TOOL_OPTIONS environment variable in the Environment Variables window instead of from the command line

1. From the Start menu, select Settings.

The Settings window appears.

2. Select System.
System settings appear with the Display tab selected.

3. Select the About tab.

The About page appears.

4. Select Advanced system settings.

NOTE

You may see a User Access Control prompt. If you have administrative access, enter your credentials. If not, contact your network admin
After you enter administrator credentials, the System Properties window appears with the Advanced tab selected.

5. Click the Environment Variables… button.

The Environment Variables window appears.

6. From the System variables section, click the New… button.

The new System Variable window appears.

7. Enter the Variable name and Variable value.

Variable name: JAVA_TOOL_OPTIONS

Variable value: "-Dos.name=Windows 7"

NOTE
You must include the quote marks (") in the Variable value to avoid errors during uninstallation.

8. Click the OK button.

The Variable name and Variable value appears under System variables.

9. Open a command prompt and Run as administrator.

10. Run UninstallRB.exe.

The Data License Request Builder uninstalls

11. From the System variables section of the Environment variables window, select JAVA_TOOL_OPTIONS > Delete.

The JAVA_TOOL_OPTIONS environment variable disappears and no longer affects any applications.

Connectivity Test Using Request Builder

Launching

1. Double click the Request Builder icon to launch the application.

2. Select the SFTP tab.

3. Select Use Keys or Use Password.

4. Complete the required fields.

Connecting

Field

Connection Label

Account (SFTP login)

Use Keys

Load Key File

Passphrase

Use Password

Password

Host

Port

Set as default login

Save

Supported Platforms
The Java programming language was chosen for the development of the Data License Front Ends software because of its portability, ease of deve

Additionally, these applications depend on some system dependent data such as the registry under MS Windows for storing information which is

The JRE version must be 1.8 or greater. The recommended version is 1.8.0_71.

Minimum Requirements
Minimum system requirements (Windows):

Intel 32-bit, AMD Opteron 32-bit/64-bit

150 MB of diskspace
128 MB of memory

Access to Available Software

Files are available in the DL SFTP directory.

Language Selection
Request Builder software is localized and currently available in both English and Japanese. Other languages may become available as the demand

This window can be reached by selecting the Reset Language option under the Settings menu of the Login window of the Request Builder and

Help

Application

API Package

Request Builder and FTP Client

Several other options are common to each application under the Help menu. They are:

Check For New Version: This option can determine whether or not the version of the application currently running is the latest version. If t

System Information: This option displays local system information and information about the application currently running. This is useful w

Contact Bloomberg: This option is a simple email client that uses the SMTP protocol to send a message. It is similar to any common email p

About: Displays a message with the application’s name, version, and date of build.

Request Builder
The Data License Request Builder was developed to assist Per Security accounts. As its name implies, it helps users author request files quickly and

Training Videos
Using Getdata Learn how to access current datasets for a list of securities and fields. Set up successful requests, save and upload them for

Downloading Data From SFTP Learn how to find and retrieve data from the SFTP once a successful request has been processed. This train

Using File Scheduler Learn how to automate the submission of request files and the retrieval of data through the File Scheduler. Viewers

Using Gethistory Learn how to access historical datasets for a list of securities and fields, within a specified date range. This training video

Using Getcompany Learn how to set up and retrieve entity level data such as industry classification and credit risk data for a set of securities

Building a BVOL Request The service offers access, on a per security basis, to an end-of-day implied volatility surface for a wide range of

Using Getactions Learn how to set up and retrieve corporate actions data for specified list of instruments. This training video assumes prio

Login Window
The first screen that appears is the Login window. This window can be bypassed by setting a default login (see Set as default login). Once this wind

To begin, select the appropriate tab of the desired application. For Data License, select the type of account that is being used, Request Builder: SF

Once the required information has been entered or selected, click on the Login button to proceed. While in Request Builder: SFTP tab, the login i

Main buttons

Clear: clears the fields on the currently selected tab

Save: saves the connection information to the Saved Connections list

Login: continues on to the main screen of the application

Saved Connections
Additionally, information for many logins may be entered and saved based on the Connection Label entered. The list of saved connection labels a

Find: searches through the connection labels that contain matching text

Delete Record: deletes selected connection

SFTP Login
Network requirement

TCP port 22 must be opened.

Must allow connectivity to the IP address to which the server host resolves. See Appendix for server Hosts and IP information.

SFTP using password

Connection Label: label for connection

Account (SFTP login): SFTP server login

Password: SFTP server password

Host: Bloomberg SFTP server name

Host Port: Bloomberg SFTP server port

Encryption Key: DES encryption key (this is necessary even when using SFTP)

Set as default login: checking this will allow this login screen to be bypassed and automatically logged in the next time the application

Bulk Account

SFTP using keys file

Connection Label: label for connection

Account (SFTP login): SFTP server login

Use Keys: load Private Keys File

Passphrase: enter the passphrase to decrypt the Keys File (this field may be blank if client has created a decrypted private key)

Host: Bloomberg SFTP server name

Host Port: Bloomberg SFTP server port

Encryption Key: optional DES encryption key

Set as default login: checking this will allow this login screen to be bypassed and automatically logged in the next time the application

Bulk Account

Send File

Connection Label: label for connection

Login (Bloomberg): Bloomberg Professional login

User Number: Bloomberg Professional user number

SN (serial number): Bloomberg Professional serial number

WS (workstation): Bloomberg Professional workstation

Bloomberg Installation Path: Bloomberg Professional installation directory

Bloomberg Download Path: Bloomberg Professional download setup directory

General Options
auto-prompt for file updates: This option is for Data License only. Turns on checks to determine whether or not the Data Dictionary (fi

auto-check for new version: This setting allows for Request Builder to confirm the latest version of the software is installed at login. This

no-check: This option is for those users who do not have an account connection or are waiting for a new SFTP login and just want to use the

auto-check backup server to submit and poll for files: This option enables redundancy in connections for submitting requests an

Encryption Program: This option allows you to supply an encryption program other than the default

Connect Timeout: The number of milliseconds before the application will timeout due to not being able to establish a connection with the

Read Timeout: The number of milliseconds before the application will timeout due to not receiving data from the server

Turn on debug mode: This option will cause logging of the application to be more verbose

SSL peer verification

SN (serial number): Bloomberg terminal serial number found on the lower left-hand corner of the screen

User Number: Unique number assigned to user

Request Builder Options

The available options change based on the Program Name selected. For detailed information on any of these options, select the Help On option f
Toolbar buttons, and their functionality:

Reset to Defaults: Resets all options to their default values.

Reset to Custom Defaults: Resets all options to the previously saved custom default values.

Save Custom Default: Saves all of the options with the currently selected values. This option is useful for the user that always sets certain o

Open: Opens a file.

Relogin: Returns to the login screen.

Select Fields: Clicking on this button starts the Field Finder (also available through the Fields option under the Select menu).

Select Securities: Clicking on this button starts the Security Selector (also available through the Securities option under the Select menu

Save: Saves the current version of the file.

View/Submit: Allow user to view request file and submit the file.

Help: Activates help window.

Download Categories
Download Categories are deprecated within Per Security, but remain an option within Request Builder. Selecting and unselecting Download Categ
Corporate Actions
The Corporate Actions Dictionary organizes all corporate actions data available. The Corporate Actions Dictionary provides information about the

When creating a request file for the getactions Program Name, specific action mnemonics or categories may be selected to filter the data that is

Field Finder
The Field Finder organizes the contents of the Data Dictionary (fields.csv). The Field Finder provides information about the available fields and is s
The fields listed in the All Fields / Search Results area can be re-sorted by any of the options or combination of options available in the Sort By dro

When viewing the field names in the All Fields / Search Results or Currently Selected Fields areas, single-clicking on the field name will populate th

Adding Fields
Fields may be added to the Currently Selected Fields list in several ways. First, the Add Mnemonic text field can be used if the field name desired

Simply type in the field name there directly. Otherwise, the field(s) that should be added must be located in the All Fields / Search Results area and

Fields may also be added from a file containing a list of fields (one on each line) or extracted from the fields section of another request file. This fu

Removing Fields
Fields can be removed from the Currently Selected Fields area by double-clicking them or by clicking on the Remove button after selecting them.

Fieldset
Clicking on the Fieldset button, available only for the getcompany program, will show the Data License Credit Risk window. The field set option o
Security Selector
The Security Selector tool is where security information (identifiers) can be entered. Data is returned in the output file according to the fields selec

Adding Securities
The securities may be directly entered in the Enter Security text field. For example, enter IBM US Equity and click on the Add button to add IBM

Securities may also be added from a file containing a list of securities (one on each line) or extracted from the data section of another request file.
Removing Securities
Securities can be removed from the Currently Selected Securities area by double-clicking them or by clicking on the Remove button after sel

Applying Date Ranges Per Security

For the gethistory, getticks, and getallticks Program Name options, a date range may be applied on a security level, which overrides the glo

Overrides Window
Overrides may be applied on a security basis from the Security Selector window. Select the fields for this request file prior to applying overrides. T

Select the field to be overridden from the Available Fields list, enter the value in the text field, and click on the Add button to have it added to t

Request Files
Saving and loading
Complete the following four steps to save a request file:

Set the options in the main window

Select the desired fields in the Field Finder

Enter the desired securities in the Security Selector

Click on the Save File button on the bottom right of the main window

To load a previously saved request file, choose the Open option under the File menu on the main window.

Viewing
After the file is saved (or a new file is loaded), the text in the Save File button changes to View/Submit File. Clicking on the View/Submit File
Poll Options
By default, polling options are not selected. To select these options, click on the poll for reply file check box. Selecting this option will enable the P

Note: if the no-check option from the Login Window is used, the poll for reply file option and the Submit button are not enabled.

The options available in this window reflect the header options selected in the Options Window. Only the options that apply for the current reques

visual alert for .copied confirmation: If this option is selected, a popup message appears when the request file has been transferre

visual alert for replyfile confirmation: If this option is selected, a popup message appears when the data file is available on the B

retrieve .datestamped file(s): If this option is selected, the file(s) with the datestamp extension will be retrieved, in addition to the res
auto-decrypt replyfile: If this option is selected, the data file will automatically be decrypted

Run Command(s): Any number of commands may be entered here to execute after the file has been retrieved. These commands can includ

Click on the Save and Return button to record any changes and return to the View File Window. Click on the Cancel button to ignore the change

Submit Request File

On the View File window, click on the Submit button and the application will take the necessary steps to submit the generated request file for proc

Status Manager
The status of request files submitted for processing during each session of the execution of the Request Builder are recorded and may be viewed

The status column for submitted request files will monitor changing from SUBMITTED to IN PROGRESS to COMPLETED if poll options have been s

Offline Usage
The Request Builder may be run in offline mode to modify the fields and/or securities of an existing file. The fields and/or securities in an existing r

The Request Builder can also be used offline to simply submit a request file via the Send File mechanism. The Request Builder will submit the requ

The arguments for all of these options are described in detail in the help pages included with the Request Builder.

Request Builder SFTP

The SFTP Client was developed to assist Data License users with SFTP connections. It is an alternative to fee-based licensed applications such as C

Retrieving and submitting files manually or automatically using a built-in scheduler

Automatic decompression and decryption

Automatic server redundancy

Complete offline functionality

Main Panel
When the FTP Client is started, the main window of the application appears. The left portion of the screen represents the local system directories a
Each side, local and remote, have optional views: the tree view and table view. The tree view is the default. It displays the directories as folders wit

The current working directories of the local and remote system are displayed in a non-editable text field labeled Current. The File Filter text fie

Options
The Options window of the FTP Client may be reached by selecting Options under the Settings menu.

A brief description of the options available:

auto-decompress .gz files: Automatically decompresses .gz (Unix gzip files) during the file transfer

auto-decrypt .enc files: Automatically decrypts encrypted files during the file transfer. Please note: Encryption may still need to be use

auto-encrypt .req files: Automatically encrypts request files that are submitted to the Bloomberg SFTP servers during file transfer

perform all maintenance on backup server also: Performs all maintenance operations such as deleting files, renaming files, etc. on th

show directories only (local): Only directories on the local system are shown

show hidden files (local): Directories and files with the hidden attribute are shown as well

Default Editor: This text field designates the default program to be used when local files are to be edited using the Edit option when se

Excel: Path to Microsoft Excel

Notepad: Path to Windows Notepad

World: Path to Microsoft Word

Wordpad: Path to Windows Wordpad

Transferring files
Manual
Transferring files to and from the Bloomberg SFTP servers manually can be done in several ways. After all file transfers, a popup message states w

While in the main window, simply double-click on the file and the transfer proceeds. To transfer multiple files (or a single file), select the files and c

The right-click menu supports a variety of options. If an option is not clear, please refer to the help pages included with the FTP Client for detailed

Automatically Via Scheduler

To transfer files automatically using the scheduling capabilities in this application, select the FTP File Scheduler option under the Settings men

The upper portion of the FTP Scheduler is for entering information required to schedule the transfer of a file. The options with a brief description a

Account Region: The account region assigned to the user by Bloomberg (New York, London, or Tokyo).

File Schedule Type: This option is used to schedule either a file to be submitted or a file to be retrieved.

File Options: The options available in this section are dependent upon the File Schedule Type chosen.

“File Schedule Type” options include:

File: File to be transferred.

Retrieve File As / Submit File As: Target filename or destination after the transfer.

Bulk file: Check box for whether or not the file being retrieved is a Bulk file or not. This option is needed since Bulk files run in the local ti

Retrieve Date / Submit Date: Date at which the scheduled transfer should occur.

Retrieve Time / Submit Time: Time at which the scheduled transfer should occur.

Retrieve Frequency / Submit Frequency: Frequency at which the file transfer should occur. This option may be one time, daily, weekly,

Run Command(s): Any number of commands may be entered here to execute after the file has been retrieved. These commands can includ

Timeout After: Specific amount of time to continue attempting to retrieve a file. After this time, if the file is still not available the program w

Timeout Action (Command): Command to be executed if the file to be retrieved is not available after the duration specified in the Timeout

match datestamp of file to retrieve date: If this option is selected, the Unix datestamp of the file on the Bloomberg SFTP server will

retrieve datestamped file: If this option is selected, only the datestamped version of the data file will be retrieved.
Once the necessary information is entered, clicking on the Add button will add the scheduled file information to the monitoring Currently Schedule

The Status column monitors and its value changes from pending to in progress to complete. The list of currently scheduled files may be sorted by

Note: Files will only be transferred when the software is running. If a file transfer is scheduled during a time when the software is not executing, it w

File Scheduler
Constructing Fields/Securities from Database or File
This feature allows users to submit a request file while loading the fields and/or securities from a different source. This is useful when the fields/sec
Click on the Open File icon to open and select folder where you would like the Database Configuration File to be saved. Type in a file name with

Supported database drivers:

Generic ODBC

Oracle Driver

SQL Server 2005

MySQL Driver

INet SprintA

Hypersonic HSQLDB

IBM DB2

Bloomberg comdb2

Sybase

Database Driver Location:

The JDBC driver file must be placed in the ...\rb7.0\lib\driver sub directory. By default that directory is C:\blp\bbdl\rb7.0\lib\d

The JDBC driver is different for each database. It is not part of the Request Builder installation. Users are responsible to provide the driver fi

Database selection:

Database Configuration File should display the full path name of the xml file input above. The rest of the window will only become activ

Connection Name: A name to save the connection. User can use the New button below to create multiple connection names
Database Driver: select the driver appropriate for the database

URL: provide the database location via URL

Configuration: provide the location of the database via Server Name, Port Number, and Database Name

Database User Name: login name of user permission to access this database

Databases Password: password of the above user

Securities query and fields query:

Input the SQL Query to fetch the securities/fields list from the chosen database.

SQL queries are database specific. Make sure to use the correct syntax for the selected database. For example, in MySQL, table named SEC

Scheduling Bulk Files

By clicking on the Add Bulk Files button, a window with special information about Bulk files is started.

The tree on the left shows all of the Bulk files available and the group names (based on the order(s) for Bulk files). Under each folder is a list of the

The File Information area contains basic information about the file. The File/Group text field shows the group the file belongs to, the Retrieve T

The right side of this screen allows for entering the options that should be applied to the Bulk files that are to be scheduled. All of the options are

S & P BO Ratings Approval Received (FixedIncSP): this option specifies whether or not the user has received approval for the specia

Moody BO Ratings Approval Received (FixedIncMoody): this option specifies whether or not the user has received approval for the spe

Once the files and settings that should be scheduled are selected, clicking on the Add button will add them to the status table of the FTP Schedule

The list of scheduled files is automatically saved. To have the FTP Client automatically transfer files via the FTP Scheduler, the application must be r

Notice Retriever
There are periodic needs to change or update specific elements of the Data License product. For every change or update, notices are created and
First, select the language(s) of the notices that should be received. Currently, English and Japanese versions of the notices are made available. The

The Check Frequency area is used to schedule notice retrievals, the options being:

one-time: check for notices now

daily at: check for notices every day at a specific time

weekly on: check for notices weekly on a specific day and time

If the notice retrievals are scheduled (daily or weekly), the Download Label at the top of the Notices Retriever becomes enabled. This is to give the

The Action area of the Notices Retriever is used to specify what to do once a notice has been retrieved. The options available are:

download file(s) to: specify the download directory for notices

visual alert: displays a message window with the notices retrieved

send as attachment: sends the notices retrieved as an email attachment to the specified email addresses (Email) or the specified SMTP se

open with: launches the notices retrieved in the specified application

run command: executes the specified command

By clicking on the Save and Return button, all scheduled notice retrievals will be saved and the application will return to the FTP Main. Clicking o

Logging
By default, the Request Builder log file is {$RB_HOME}\reqbuilder.log, example, C:\blp\bbdl\rb6.0\reqbuilder.log. The logging properties

Debug
This is a hidden window available to the Request Builder application to control debug log verbosity. To have access to this, use the Request Build
History
A view of historical SFTP and Request Builder activity is stored and may be viewed by selecting the History option from the View menu. It is a con

Production Scenarios
Every user has different needs. The Front Ends software may be used in a variety of different ways to greatly reduce the amount of time needed to

All of the scenarios that follow refer to processing the file as the final step. This term is used to denote anything the user wants to do with the data
Scenario I First Time User (Per Security)
New Per Security users can review the Per Security product functionality by running the Request Builder and following the tutorial in its help pages

Scheduling Request Files (Per Security) and Retrieving Data Files (Per Security and Bulk)
There are two main ways to schedule a request file to process. The first is to use the PROGRAMFLAG header option inside the request file and the sec

Scenario

Content changes often

Consistent processing time

If the PROGRAMFLAG header option is chosen to schedule the file, the request file can be generated and submitted using the Request Builder. Intern
If the FTP Scheduler option is chosen to schedule the file, the scheduling of the request file will need to be done on the user system. Any of the fo

Field list in the request file

Security list in the request file

Days the request file should be processed

Time at which the request file should be processed

These changes to the request file can be made with the offline mechanism of the Request Builder. Given an existing request file and a file with the

Changes, Requests, New Features

Enhancement Notices
New versions of Bloomberg Data License Front Ends software are announced in the enhancement notices released by Bloomberg Data License. T

Version Control
The version of these applications may be found by selecting the About option under the Help menu. New versions are announced in the enhance

Consulting Services
Bloomberg Data License offers consulting services to users who need special data formats. Contact the Data License Sales Department for details
© 2025 Bloomberg L.P. All rights reserved. Contact Us Terms of Service Trademarks Privacy Policy

Learn SAP Basis in 24 Hours
From Everand
Learn SAP Basis in 24 Hours
Alex Nordeen
4.5/5 (2)
Solved Java
No ratings yet
Solved Java
28 pages
Data Communication and Network
No ratings yet
Data Communication and Network
6 pages
Asset Data Migration
100% (1)
Asset Data Migration
80 pages
Ultimate Java CheatSheet
100% (1)
Ultimate Java CheatSheet
4 pages
Building Socket Applications
No ratings yet
Building Socket Applications
13 pages
Syllabus MATDIP301 MATDIP401
No ratings yet
Syllabus MATDIP301 MATDIP401
8 pages
Next Steps.: Port Forwarding
No ratings yet
Next Steps.: Port Forwarding
1 page
SAPTechnical Idoc & Ale
No ratings yet
SAPTechnical Idoc & Ale
53 pages
Lync Edge Server Best Practices
No ratings yet
Lync Edge Server Best Practices
7 pages
AV-FREE-FEED Network Scan, Local Host Scanning Port 445TCP
No ratings yet
AV-FREE-FEED Network Scan, Local Host Scanning Port 445TCP
10 pages
Internet Application
No ratings yet
Internet Application
15 pages
DCOM Configuration Guide - OPCInt PDF
No ratings yet
DCOM Configuration Guide - OPCInt PDF
25 pages
Objective: Single Sign On
No ratings yet
Objective: Single Sign On
42 pages
Thrift
No ratings yet
Thrift
15 pages
IOS Networking Topics
No ratings yet
IOS Networking Topics
36 pages
LSMW Migration With IDOC Method and BAPI
100% (1)
LSMW Migration With IDOC Method and BAPI
47 pages
SY0 501 Demo
No ratings yet
SY0 501 Demo
13 pages
Edocument Italy - Communication Channel Registration - Cloud Foundry
No ratings yet
Edocument Italy - Communication Channel Registration - Cloud Foundry
20 pages
SOAP Web Services Best Practices - BMC Communities
No ratings yet
SOAP Web Services Best Practices - BMC Communities
7 pages
25 ASP Q &a
No ratings yet
25 ASP Q &a
7 pages
Chapter 5
No ratings yet
Chapter 5
12 pages
Generate SSL Certificates With OpenSSL For SAP Systems
No ratings yet
Generate SSL Certificates With OpenSSL For SAP Systems
60 pages
Interview Questions
No ratings yet
Interview Questions
63 pages
Manual Casa Marcat
No ratings yet
Manual Casa Marcat
4 pages
Documentation
No ratings yet
Documentation
192 pages
Developer IT Pro Business Central
No ratings yet
Developer IT Pro Business Central
922 pages
Window Server 2008 Lab Manual
No ratings yet
Window Server 2008 Lab Manual
51 pages
Online Electricity Bill Payment
71% (7)
Online Electricity Bill Payment
21 pages
Chat Server
No ratings yet
Chat Server
16 pages
Active Directory Replication Over Firewalls
No ratings yet
Active Directory Replication Over Firewalls
22 pages
Basic Networking Interview Questions With Answer
No ratings yet
Basic Networking Interview Questions With Answer
4 pages
Visual Basic 2010 Coding Briefs Data Access
From Everand
Visual Basic 2010 Coding Briefs Data Access
Kevin Hough
5/5 (1)
Guia de Administrador
No ratings yet
Guia de Administrador
189 pages
Helix, Hacking
No ratings yet
Helix, Hacking
15 pages
Bandwidth+Dashboard+API+Users+Guide+ +version+1.3.3
No ratings yet
Bandwidth+Dashboard+API+Users+Guide+ +version+1.3.3
81 pages
Computer System Sevicing (Configure Server Function) : Capslet
No ratings yet
Computer System Sevicing (Configure Server Function) : Capslet
12 pages
Manual Config HttpsConnections NEWOSS
No ratings yet
Manual Config HttpsConnections NEWOSS
18 pages
Web Service
No ratings yet
Web Service
6 pages
Electronics Review Website: Ishan Jaiswal 0631153007 ICE
No ratings yet
Electronics Review Website: Ishan Jaiswal 0631153007 ICE
28 pages
Laravel Technical Document (1)
No ratings yet
Laravel Technical Document (1)
10 pages
PDF
100% (1)
PDF
243 pages
C# 2010 Coding Briefs Data Access
From Everand
C# 2010 Coding Briefs Data Access
Kevin Hough
No ratings yet
Web Development
No ratings yet
Web Development
53 pages
SAP Crystal For Enterprise 4 0
No ratings yet
SAP Crystal For Enterprise 4 0
78 pages
Openssl Essentials: Working With SSL Certificates, Private Keys and Csrs
No ratings yet
Openssl Essentials: Working With SSL Certificates, Private Keys and Csrs
6 pages
What Are XML Web Services?
100% (1)
What Are XML Web Services?
22 pages
Transaction Code SCC4
No ratings yet
Transaction Code SCC4
19 pages
CEH Module 4
No ratings yet
CEH Module 4
133 pages
Sap Basis Faq 1
No ratings yet
Sap Basis Faq 1
9 pages
PDF
No ratings yet
PDF
11 pages
Develop Your Own Database Software
No ratings yet
Develop Your Own Database Software
25 pages
C#Web Basics SQL
No ratings yet
C#Web Basics SQL
113 pages
BPC 10 For NetWeaver LoadRunner Toolkit
No ratings yet
BPC 10 For NetWeaver LoadRunner Toolkit
17 pages
FON Unit IV - IoT
No ratings yet
FON Unit IV - IoT
29 pages
SAP DMS Installation Document
No ratings yet
SAP DMS Installation Document
22 pages
Delphi Informant Magazine Vol 6 No 6
No ratings yet
Delphi Informant Magazine Vol 6 No 6
37 pages
Transactional Behavior Verification in Business Process As A Service Configuration
No ratings yet
Transactional Behavior Verification in Business Process As A Service Configuration
91 pages
Part4 Idocs
100% (1)
Part4 Idocs
10 pages
How To Remote Desktop Through A Proxy Server To A Terminal Server
No ratings yet
How To Remote Desktop Through A Proxy Server To A Terminal Server
10 pages
Evaluation of Some SMTP Testing, Email Verification, Header Analysis, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
From Everand
Evaluation of Some SMTP Testing, Email Verification, Header Analysis, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
Dr. Hidaia Mahmood Alassoulii
No ratings yet
Securing .NET Web Services with SSL: How to Protect “Data in Transit” between Client and Remote Server
From Everand
Securing .NET Web Services with SSL: How to Protect “Data in Transit” between Client and Remote Server
Slava Gomzin
No ratings yet
Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WP Email Tools: Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
From Everand
Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WP Email Tools: Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
Dr. Hedaya Alasooly
No ratings yet
Pid Arduino Uno
No ratings yet
Pid Arduino Uno
3 pages
ProVU4 Full Manual PDF
No ratings yet
ProVU4 Full Manual PDF
184 pages
Constitutive Model Plug-Ins
No ratings yet
Constitutive Model Plug-Ins
13 pages
18CS45 - Ooc - Module 1
No ratings yet
18CS45 - Ooc - Module 1
123 pages
Atm
0% (2)
Atm
31 pages
2.2.1. Programming Techniques
No ratings yet
2.2.1. Programming Techniques
6 pages
ABAP5
No ratings yet
ABAP5
2 pages
Paramiko Docs
No ratings yet
Paramiko Docs
92 pages
Verbatim
No ratings yet
Verbatim
21 pages
RSI Manual
No ratings yet
RSI Manual
8 pages
Materi Pengolahan Citra Digital 4c Sesi 11-12 Image Transformations
No ratings yet
Materi Pengolahan Citra Digital 4c Sesi 11-12 Image Transformations
16 pages
Old Shalimar Academy Old Shalimar Academy Old Shalimar Academy Old Shalimar Academy
No ratings yet
Old Shalimar Academy Old Shalimar Academy Old Shalimar Academy Old Shalimar Academy
1 page
The Command Interpreter
No ratings yet
The Command Interpreter
8 pages
Matlab Release Notes
No ratings yet
Matlab Release Notes
628 pages
Operating Manual BST Ekr DIGICON 118
No ratings yet
Operating Manual BST Ekr DIGICON 118
32 pages
PPM 300 Data Sheet 4921240464 Uk
No ratings yet
PPM 300 Data Sheet 4921240464 Uk
60 pages
Atlas Copco Tools Talk Tps Manual
50% (2)
Atlas Copco Tools Talk Tps Manual
76 pages
Software Standards: Unified Model Documentation Paper 003
No ratings yet
Software Standards: Unified Model Documentation Paper 003
27 pages
RSD Lite Version 4.6 User Manual & Release Notes 09/27/2009
No ratings yet
RSD Lite Version 4.6 User Manual & Release Notes 09/27/2009
21 pages
Modal Analysis of A Simulated System and A Wind Turbine Blade Example
No ratings yet
Modal Analysis of A Simulated System and A Wind Turbine Blade Example
20 pages
Wiki Notation Guide
No ratings yet
Wiki Notation Guide
94 pages
KLIC-DI V2 Installation and Operation Manual V1.0a English
No ratings yet
KLIC-DI V2 Installation and Operation Manual V1.0a English
38 pages
8086 Assembler Tutorial For Beginners (Part 10)
100% (1)
8086 Assembler Tutorial For Beginners (Part 10)
3 pages
Understanding Visual Basic Commands and Syntax
No ratings yet
Understanding Visual Basic Commands and Syntax
31 pages
C++ Function Part 1
No ratings yet
C++ Function Part 1
41 pages
Pthreads Intro
No ratings yet
Pthreads Intro
9 pages
Js in Ten Minutes
No ratings yet
Js in Ten Minutes
27 pages