GETTING STARTED WITH AN XIGNITE TRIAL
GETTING STARTED
Register for free trial
You can choose one API for the trial
Your trial is for a maximum of 250 hits
A Word About Hits
Most calls you make consume hits XigniteBondsRealTime
(some are free).
The number of hits a call consumes XigniteGlobalOptions
depends on the API and your INPUT
parameters (e.g. number of
symbols).
If you exceed your 250 trial hits, you
will see an error message and will
not be able to use the service for
additional calls.
We do not offer trials of these APIs:
Service Rules
XigniteGlobalQuotes Required for all exchanges
XigniteGlobalRealTime
XigniteGlobalHistorical
Required for all exchanges
JSE (Johannesburg) and Tokyo Stock Exchange need an
agreement
XigniteBATSRealTime BATS license needed for accessing realtime data
XigniteNASDAQLastSale NASDAQ license needed for accessing Last Sale data
Require FINRA license for US Corporate Bonds data
XigniteFunds NASDAQ MFDS license need for accessing intraday data
XigniteGlobalRealTimeOptions
OPRA (Options Pricing and Reporting Authority), Montreal
Exchange
XigniteGlobalIndices
XigniteGlobalIndicesRealTime
Needed for Dow Jones, S&P (MDX), NASDAQ, NYSE and most
indices
XigniteInterbanks
XigniteRates
LIBOR and EURIBOR require agreements
Some real-time APIs
require exchange
agreements.
Learn More
OUR API CATALOG
HTTPS://WWW.XIGNITE.COM/PRODUCTS/

This view gives you

instant access to all
the available
services.

Click here to go
You can filter to the APIs and
APIs by asset test form
class,
frequency, data
types and
region
WEB SERVICE PAGE
HTTPS://WWW.XIGNITE.COM/PRODUCT/FACTSET-ANALYST-ESTIMATES/

The name of
the web service

Drill down to Learn about

the API list related services

Check out our data

sources
Review the
data coverage

Review the key

data points
THE API LIST
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS//#/DEVELOPERRESOURCES/REQUEST

Find the APIs

you need easily

Lists APIs are listed first.

Then the main APIs come
next. Less frequently used
APIs are listed last.

APIs are organized by group

of related APIs. For instance
APIs that list items will be
grouped together, or chart
APIs will be grouped as well.
THE API PAGE
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS//#/DEVELOPERRESOURCES/REQUEST

The name of
the API

The description Pick the output

for the API format of your
choice

The test form for

The color coded
the API. Enter your
URL for your
parameters here
parameters. Click
on it to open a new
Click on this button tab and pull up the
to view the results
results. This will
consume your hits!
Full Output
Documentation is
available here.
USING THE TEST FORM
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS//#/DEVELOPERRESOURCES/REQUEST

The test form is

designed to help you
play with the API as
you implement it.

Drop downs and Type

Ahead functionality are Click on ?" to see the
available for certain parameters
input parameters. description

You can type partial The system

values and see which dynamically
ones match updates the URL
based on your
Click View Results to choices
see the results of your
call
CHOOSING YOUR OUTPUT FORMAT
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS//#/DEVELOPERRESOURCES/REQUEST

All our APIs support XML,

JSON or CSV formats.

You can choose to view the

output in a Grid format, in
XML, JSON or CSV. Just
pick the tab you want and
The URL
click View Results extension
updates
automatically
You can see how many hits based on the
your call consumed and how format you
many you have left. choose.

The output of the call is

displayed in the format you
choose.
ACCESSING DOCUMENTATION
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS#/DEVELOPERRESOURCES/REQUEST/GETNAV

All our documentation

is online or available for
download on the web site.
If you dont see it, most
likely we do not have it!

Scroll down for the

output documentation.

These 4 fields (Outcome,

Message, Identity,
Delay) are standard on all
outputs
STANDARD OUTPUT VALUES
THEY ARE ALWAYS THERE

This field describes the outcome of the method. Possible values are:
Outcome Success, SystemError, RequestError and RegistrationError.

A short message describing the error if the Outcome field contains a

Message RequestError or RegistrationError.

This field describes how the call was authenticated. Possible values
Identity are: IP, Cookie, Header and Request.

This field reports the time it took for the server to complete a request, in
Delay a decimal format measured in seconds (Example: 0.0016). This does
not take into account any latency experienced by the caller.
CUSTOMIZING YOUR API CALLS
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS#/DEVELOPERRESOURCES/REQUEST/GETNAV

You can customize Note that this

the output of each capability is only
API by picking the available for REST
fields you want to calls.
retrieve. This
simplifies coding
and speeds your The system then
calls by limiting automagically creates
network traffic. a _fields request
parameter that lists
the fields you picked.
Just go to the
Customize Tab and
click the fields you
want. You can When you click View
unselect all the fields Result, you can see
first and pick those that the output only
you want. includes your choices.
AUTHENTICATING YOUR API CALLS
AUTHENTICATION TOKENS
We authenticate your calls using a token
You can maintain your tokens within the My Account section of our website.
Tokens are a randomly generated alphanumeric value. We no longer support creation of user
specified tokens or IP address authentication for security reasons.
Our web test form automatically inserts an encrypted token with automatic expiration for enhanced
security. Only if your agreement includes calling our APIs directly from your end devices (users) do
you need to implement encrypted tokens.
You can have as many tokens as you want.
4 WAYS TO AUTHENTICATE REQUESTS
DEPENDS ON HOW YOU CALL THE SERVICE
REST
_token request parameter in
your URL
See the Code tab in the test form
Cookie
Created when you log in
Used when using web site or browser
This is why you can play around the
API when logged in
SOAP
Username value in Header Object
Different based on language
See the Code tab in test forms
IP Address
Used by default if no other
option provided
You can register your IP as a token
SAMPLE CODE AND GUIDELINES
HTTP://WWW.XIGNITE.COM/PRODUCT/GOLD-METAL/API/GETLASTREALTIMEMETALQUOTE

Simply click on a
section to see the This critical section
sample code for shows you how to
that language. pass your
authentication token
in the code.

You must do some You need to assess

error handling! the value of the
You could get no Outcome field to
data back if the know if you got the
internet connection right data back.
is down. We
recommend you We always provide
implement retries details in the Message
as well. field. You can display
that field back to the
user.
ASSESSING OUTCOME VALUES
4 POSSIBLE OUTCOMES

Success
All is well. Proceed with your logic.

RequestError
There was something wrong with your request. Data could not be found.
Check out the value of the Message field for details.

RegistrationError
We could not authenticate your request because of a bad token or expired subscription.
Check out the value of the Message field for details.

SystemError
We messed up. Something went wrong on our side (should not happen often).
Retry and contact support@xignite.com if it persists.
THE HARD CORE STUFF
HTTP://WWW.XIGNITE.COM/PRODUCT/GOLD-METAL/API/GETLASTREALTIMEMETALQUOTE

If you are a bit more You can see the

hardcore and use inputs and
REST, you will want to outputs of SOAP
know what a request calls as well.
and output look like.
You can access this
section by scrolling
And here is a
down in the Code Tab.
sample XML
output so that you
know how to
This shows you the parse it.
format of a REST call.
Although you want to
fully construct the URL
with your parameters
Valid values for
and authentication
enumerations are
token.
always listed.
THE URL
DECONSTRUCTING THE COMPONENTS

You can use The domain The extension that

The
HTTP or name for the defines the format of The name
service
HTTPS. service. It is not your output (xml, of the API
name
Always! always the same! json, or csv)

https://globalmetals.xignite.com/xGlobalMetals.xml/GetRealTimeMetalQuote?
Symbol=XAU&Currency=USD&_fields=Date,Time,Bid,Ask&_token=mytoken

The input parameter s. This list [optional] The list of

will entirely depend on the API fields you want to get in
[optional] Your
you call. Some APIs have no the output. If not
authentication token.
parameters, some have 8 to 10 provided, all fields are
parameters. returned.
TECHNICAL RESOURCES
HTTPS://WWW.XIGNITE.COM/PRODUCT/MUTUAL-FUND-NAVS#/DEVELOPERRESOURCES/REQUEST/GETNAV

The Code Tab

Authentication
provides you with
is critical. This
many useful technical
section explains
resources!
how to do it.

If you use SOAP, your

We provide
SOAP toolkit will ask
customized
you the address of
sample code in
the WSDL for the
many
service.
languages. Just
cut and paste it
in your code
editor!
MANAGING YOUR ACCOUNT
HTTPS://WWW.XIGNITE.COM/MYACCOUNT/

Basic password
stuff.
Access My
Account by
And basic clicking on your
account stuff. email address

Manage your
tokens here.
Your tokens work
for all your
services!

Check your
subscriptions
If you use IP based
and free trial Your Subscription Status
authentication, you can add
status here. will show you how many hits
new IPs using Manage My
you have consumed.
API Tokens
MANAGING YOUR TRIAL USAGE
HTTP://WWW.XIGNITE.COM/PRODUCT/GOLD-METAL/API/GETLASTREALTIMEMETALQUOTE

The API you registered

for the trial has its own
logic for the number of
hits it consumes. It will
stop working after 250
hits.

A weekly chart of your

usage for this specific
API. You can see both
the number of hits and Note that the chart is
the average delay for all updated at the end
call. of the day.
GETTING HELP
Search our Knowledge Base for topics. We may have already answered
your question.
Contact sales@xignite.com if you have questions about your free trial or
to purchase an API subscription.
Please do not open a ticket or call our Support team with questions about
your free trial. Let us know if there is anything else we can do.