0% found this document useful (0 votes)
41 views17 pages

API User Guide

Uploaded by

cricsip5
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
41 views17 pages

API User Guide

Uploaded by

cricsip5
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Morningstar, Inc.

Licensed Data:
API Center User
Guide

Morningstar API User Guide 0


Table of Contents
Product Overview 2
API Center Tab: Home Page
View a Preconfigured API 3
View the API Schema 4
View a Sample Output 4

API Center Tab: API Builder


Navigate to the API Builder 5
Add data points by Preconfigured API 5
Add data points by searching 5
Save an API 6

API Center Tab: Universe Builder


Navigate to the Universe Builder 6
Create universe by searching for investments 6
Create universe by uploading a list of investments 7
Create universe by designating search criteria 7

API Center Tab: Feed Builder


Navigate to the Feed Builder 8
Create a data feed with current (non-historical) data 8
Select the data points 8
Select the investments 9
Specify the data output 9
Create a data feed with historical data 10
Select the data points 10
Select the investments 10
Specify the data output 11

API Center Tab: Client Account


Navigate to the Client Account 11
API Inventory 12
Run an API from the API Inventory 12
Configure your API to interact with a Universe 12
Configure your API to interact with a single identifier 13
Universe Inventory 13
Configured Feed Inventory 14
Configured Feed - Actions 14
Generate
Edit
Delete
Clone
Schedule a Data Feed for future production 15

Additional Resources
Additional Tabs - Authentication 16
Additional Tabs - Restore Deleted 16
Technical Documentation and User Guide 16

Morningstar API User Guide 1


Product Overview
The Morningstar API Center is designed to provide access to clients for data that is currently
available by making a direct call to the Morningstar database for a specific investment.
Additional functionality allows for the user to create their own APIs, retrieve data for a specific
universe or use the Morningstar APIs to generate a configured data feed in a format specific to
their needs.

User Functionality Example Usage


Standard API
Utilize a preconfigured API to Asset Allocation - Details a portfolio's exposure across different
pull like data sets for specified asset categories including Cash, Equities and Bonds
investments
Trailing Total Returns – Month-end data for multiple time periods

Fund Benchmarks – Returns a list of Morningstar and Prospectus


assigned benchmark names and IDs

Custom API
Build a custom API to access A user interested in accessing select data points can create a
only the data specified by the custom API that performs a live call to the Morningstar database to
user return only those data points specified by the user.
The custom API can be used with a single identifier, like ticker or
CUSIP or can return data on a predetermined universe of
investments, also specified by the user.

Custom Universe
Create a custom and dynamic A user may filter the Open End Fund Universe by number of Star
investment universe through Ratings received, by legal structure, by Morningstar Category, by
filter-based requirements Morningstar Style Box placement or using certain attributes like
specified by the user “Exchange Traded Share” or Available for Insurance Product” tags.

When the universe is accessed, it returns all investments that meet


the pre-specified criteria allowing for a dynamic generation process.

Custom Data Feed


Build a custom data feed with User can surface current or historical data, select specific data
the ability to specify a Comma points, load an investment list and specify the output format. The
Separated Value (CSV) or Text configured feed is stored in the user's account to be generated on a
format output predetermined schedule, or upon accessing the API center.
For example, a user can select the Morningstar Style Box
designation, trailing month-end 6-month return and Morningstar
Category for a select list of 200 funds.
Additional Functions
Custom APIs and Data Feeds are automatically stored in the user's account, able to be edited or
generated at any time allowing for true on-demand access to Morningstar data.

Custom Data Feeds can be scheduled for future or routine generation. For example, a user can
schedule a feed to be emailed to their team on a weekly basis, or a user can schedule a feed to post to
an FTP site on a monthly basis for an automated process to access.

Morningstar API User Guide 2


API Center: Home Page
When logged into the API center, the Home Page can be accessed by a tab
on the navigation bar.

Locate the Home Page

The Home Page of the


Morningstar API Center houses
preconfigured APIs that are
accompanied by helpful
documentation unique to each
API: Definitions, Input Parameters,
Data Output Examples and the
associated API Schema.

View a Preconfigured API

To learn more about the


preconfigured APIs that
Morningstar can offer your firm,
simply choose from the
Operational, Performance or
Portfolio data selections and
browse the available options. In
the following example, a Basic
Information API is highlighted,
showing fund share class level
operational detail.

Morningstar API User Guide 3


API Center: Home Page, Continued

View an API Schema

To view a sample schema for your


selected API, choose the Schema
option along the horizontal menu
bar and the resulting schema will
display in the data window.

View Sample Output

To view the sample output from


your selected API, choose the
Output Sample option along the
horizontal menu bar. Use the
drop down menu labeled
Identifier Type to select your
input parameter from common
identifier options: Ticker, CUSIP,
ISIN, FundServ Code, Morningstar
SecID. Enter the Identifier into
the text box and select Get
Output Sample.

Note
If your API Center account is
permissioned to access an API,
you will see the corresponding
API URL available within the
Documentation page of the
interface. If you are not
permissioned for a certain data
set, you will see all corresponding
documentation and will be able to
access the Output Sample, but the
implementation URL will not be
visable. If you are interested in
licensing an API you are not
permissioned for, contact your
Relationship Manager.

Morningstar API User Guide 4


API Center: API Builder
When logged into the API center, the API Builder can be accessed by a
tab on the navigation bar.

Locate the API Builder

The API Builder allows you to


create customized APIs, accessing
only the data points you select to
utilize and storing and saving the
custom API for ongoing use.
There are two ways you can add
data points to your API, discussed
in the next sections.

Search by API

To add data points to your custom


API, the Search by API function
allows you to locate data points
within their preconfigured APIs.
For example, a user who wanted a
portfolio’s bond exposure, could
Add only the “Bond” data points
from the Asset Allocation
Breakdown API.

Search by Data Point

To add data points to your custom


API, the Search Data Points
option allows the user to type key
words or phrases in the text box
to show resulting options. For
example, typing “style” into the
text box returns four results.

Morningstar API User Guide 5


API Center: API Builder, Continued

Save the API

Once you have added your data


points, save your custom API by
selecting the Done button on the
lower left corner. Saving your API
will move it to the Client Account
page, where it can be accessed,
modified or deleted at any time.

The Client Account tab is discussed


further on page 11.

API Center: Universe Builder


When logged into the API center, the Universe Builder can be accessed
by a tab on the navigation bar.

Locate the Universe Builder

The Universe Builder allows you


to create a custom investment
universe containing only the funds
you select, or that meet certain,
pre-specified criteria.

Search for individual


investments

To create an investment universe,


you can use the Enter Identifier
option to search for investments
by entering common identifiers,
like name, ticker, etc. Select the
investment and use the Add
function to include it in your
custom universe.

Morningstar API User Guide 6


API Center: Universe Builder, Continued

Upload a List of Investments

To create your universe, you can


also use the Upload Identifier
option to upload a list of common
identifiers, like ticker or CUSIP.
Note that a simple text file with
one identifier per line is the best
way to upload a custom
investment list.

Search by Criteria

Use the Select Region or


Exchange option to search the
Morningstar database by
specifying Universe Type or
Region. Use the Filter Results
option, to include further search
options like Morningstar Rating or
Morningstar Category.

Morningstar API User Guide 7


API Center: Feed Builder
When logged into the API center, the Feed Builder can be accessed by a
tab on the navigation bar.

Locate the Feed Builder

The Feed Builder allows you to


create a custom data feed by
specifying the data points and
investments you want returned in
a data feed. You can also choose
the feed output format. When
creating a custom feed, you have
the option to choose from current
or historical data points.

Create a Data Feed with


Current Data – Step 1

Select Available Data Points to


begin building your data feed with
current (non-historical) data. Note
that Current and Historical data
cannot be combined as a single
feed.

Create a Data Feed with


Current Data – Step 2

Choose your data points by


Searching by API (Select Data
Points) or by Searching by Data
Point.

Note you can use the gray forward


and back arrows to move through
the feed builder sections: Data
Source, Select Data Points, Create
Universe and Output Parameters.

Morningstar API User Guide 8


API Center: Feed Builder, Continued

Create a Data Feed with


Current Data – Step 3

Once you have chosen your data


points, you can either search for
or upload a list of investments to
create your universe.

Use the Enter Identifier Option


to search by individual
investments using Name, Ticker,
CUSIP, etc.

Use the Upload Identifier Option


to upload a text file of investment
identifiers.

Create a Data Feed with


Current Data – Step 4

Once you have chosen your data


points and your investments, you
can customize the Output
Parameters. The radio buttons
on the Export Options menu
allow you to specify your format,
character encoding and header
inclusion preference. The text
boxes on the right menu allow you
to customize the header label, for
example, changing
“MaximumManagementFee” to
“Mgt Fee - Max”.

Saving your settings moves the


configured API to your Client
Account Page, further discussed
on page 11.

Morningstar API User Guide 9


API Center: Feed Builder, Continued

Create a Data Feed with


Historical Data – Step 1

Select Available Historical data


Points to begin building your data
feed with historical data. Note
that Current and Historical data
cannot be combined as a single
feed.

Create a Data Feed with


Historical Data – Step 2

Choose a historical API to add to


your configured feed. Note that
due to the nature and size of
historical data, a single API should
be chosen per feed.

Create a Data Feed with


Historical Data – Step 3

Once you have chosen your data


points, you can either search for
or upload a list of investments to
create your universe.

Use the Enter Identifier Option


to search by individual
investments using Name, Ticker,
CUSIP, etc.

Use the Upload Identifier Option


to upload a text file of investment
identifiers.

Morningstar API User Guide 10


API Center: Feed Builder, Continued
Create a Data Feed with
Historical Data – Step 4

Once you have chosen your data


points and your investments, you
can customize the Output
Parameters. The radio buttons
on the left menu allow you to
specify your format, character
encoding and header inclusion
preference. The text boxes on the
right menu allow you to customize
the header label.

With historical APIs, you can also


specify the Start and End date of
the time period of the returned
data.

Saving your settings moves the


configured API to your Client
Account Page, further discussed
on page 11

API Center: Client Account


When logged into the API center, the Client Account can be accessed by
a tab on the navigation bar.

Locate your Client Account

The Client Account tab houses


all of your saved and configured
APIs, Universes and Data Feeds.

Assets Tab

Within the Client Account Tab, the


Assets Tab hosts the API
Inventory, Universe Inventory and
Configured Feed Inventory. From
here, you can access, edit and
delete your API Center
deliverables.

Morningstar API User Guide 11


API Center: Client Account – API Inventory

Locate the API Inventory

Within the Client Account tab, the


API Inventory allows you to
access your configured APIs at
any time. The Edit, Delete and
Clone features can be accessed
from this page.

Run an API

By selecting the + next to your API,


you have the option of running the
API with a single identifier or with a
configured custom universe.

Selecting URL with the UniverseID


parameter will allow you to use a
configured, custom universe.

Selecting the URL with the IDType


parameter will allow you to pass in
a single identifier, like ticker.

Run an API – Universe ID

Selecting the URL with the


UniverseID parameter will prompt
a pop-up window with the option to
select the ID associated with your
desired custom universe, as well as
the access code from the drop
down menus.

Access codes are discussed further


on page 16.

Morningstar API User Guide 12


API Center: Client Account – API Inventory, Continued

Run an API – Universe ID,


Continued

Selecting the Final URL will open


the API in your browser window.
The Final URL can be patched into
the End Application.

Run an API – Single


Identifier

Selecting the URL with the


IDType parameter will prompt a
pop-up window with the option to
select the ID type and enter the
identifier in the text box. Choose
your access code from the drop
down box. Access codes are
discussed further on page 16.

Selecting the Final URL will open


the API in your browser window.
The Final URL can be patched into
the End Application.

API Center: Client Account – Universe Inventory

Locate the Universe Inventory

Within the Client Account tab, the


Universe Inventory section
serves as a repository for all
configured universes. From here,
you can Edit, Delete or Clone a
universe at any time. The
Universe Code listed here can be
manually or automatically
integrated into your saved APIs and
Feeds.

Morningstar API User Guide 13


API Center: Client Account – Configured Feed

Locate the Configured Feed


Inventory

Within the Client Account tab, the


Configured Feed Inventory serves
as a repository of all configured
feeds.

Note that the + button allows your


Feed to interact with a custom
Universe or single identifier in the
same fashion described in the Run
an API section outlined on page 12.

Configured Feed Actions

Generate: To generate your feed,


simply click the Generate button on
your client account. Your feed will
output in your selected format.

Edit: To edit a feed you have


already created, click the Edit
button and make necessary
changes to data source, data
points, investment universe or
output parameters.

Delete: To delete a feed, select


the Delete button. Deleting a feed
will move the feed to the Deleted
Assets tab in the client account in
case you need to restore the feed.

Clone: To make a copy of an


existing feed, select the Clone
button. A duplicate feed with the
original name + “CLONE” will
appear in your Feed Inventory.

Morningstar API User Guide 14


API Center: Client Account – Configured Feed, Continued

Schedule a Feed for Delivery

Using the Scheduler option


allows you to create an ongoing
automated feed delivery

The Scheduler button will create a


pop-up window with delivery
options.

FTP: You can choose to produce


your feed to an internal FTP or to a
Morningstar FTP Directory. Ask
your Client Manager for additional
details regarding FTP delivery.

Email: You can schedule your


feed for delivery via email, by
entering the email address in the
text box.

Delivery frequency and delivery


time can be chosen to your
preference.

Morningstar API User Guide 15


API Center: Client Account – Additional Tabs

Authentication Tab

Within the Client Account Tab, the


Authentication Tab allows you to
view your Access Codes and other
Client Authentication Credentials.
For additional information on Client
Authentication, contact your Client
Manager.

Restore Deleted Assets Tab

Within the Client Account Tab, the


Restore Deleted Assets tab allows
you to restore any deleted APIs,
Universes or Configured Feeds
back to your Assets Tab.

API Center: Technical Documentation & User Guide

Technical Documentation &


User Guide

The Technical Documentation and


User Guide tabs serve as a
resource for authentication, best
practices and FAQs. Contact your
Client Manager with any technical
or implementation questions.

Morningstar API User Guide 16

You might also like