Getting Started

Our API Catalog Visit the page

This view gives you instant access to all the available services.

You can filter APIs by asset class, frequency, data types and region.

Click here to go to the APIs and test form.

API List and Documentation Visit the page

The name of the web service.

Drill down to the API list.

Review the data coverage.

Learn about related services.

The API Page Visit the page

The name of the API.

The description of the API.

The test form for the API. Enter your parameters here.

Click on this button to view the results. This will consume your hits!

Pick the input format of your choice.

The color coded URL for your parameters. CLick on it to open a new tab and pull up the results.

Full Output Documentation is available at the bottom.

API Endpoints Visit the page

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 groups of related APIs. For instance APIs that list items will be grouped together, or chart APIs will be grouped as well.

Download PDF

Using the Test Form Visit the page

The test form is designed to help you play with the API as you implement it.

You can type partial values and see which ones match.

Click View Results to see the results of your call.

Drop downs and Type Ahead functionality are available for certain input parameters.

Click on "?" to see the parameter's description.

The system dynamically updates the URL based on your choices.

Choose Your Output Format Visit the page

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 click "View Results".

The output of the call is displayed in the format you choose.

Standard Output values

Outcome

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

Message

A short message describing the error if the Outcome field contains a RequestError or RegistrationError.

Identity

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

Delay

This field reports the time it took for the server to complete a request, in a decimal format measured in seconds (Example:0.0016). This does not take into account any latency experienced by the caller.

Access Documentation Visit the page

Scroll down for the output documentation.

These 4 fields (Outcome, Message, Identity, Delay) are standard on all outputs.

All our documentation is online or available for download on the web site. If you don't see it, most likely we do not have it!

Customize Your API Calls Visit the page

You can customize the output of each API by picking the fields you want to retrieve. This simplifies coding and speeds your calls by limiting network traffic.

Just click Customize Request and click the fields you want returned. You can unselect all the fields first and pick those you want.

Note that this capability is only available for REST calls.

The system then automatically creates a _fields request parameter that lists the fields you picked.

When you click View Result, you can see that the output only includes your choices.

Download PDF

Authenticate Your API Calls

We authenticate your requests using a token

You can maintain your tokens within the My Account section of our website.
Tokens are a randomly generated alphanumeric value. We do not 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.

3 Ways to Authenticate Requests

REST

_token request parameter in your URL
See the Code tab in the test form

SOAP

Username value in Header Object
Different based on language
See the Code tab in test forms

Created when you log in
Used when using web site or browser
This is why you can play around the API when logged in

Download PDF

Using REST Visit the page

If you use REST, you will want to know what a request and output look like. You can access this section by scrolling down in the Code Tab.

This shows you the format of a REST call. Although you want to fully construct the URL with your parameters and authentication token.

You can see the inputs and outputs of SOAP calls as well.

And here is a sample XML output so that you know how to parse it.

Valid values for enumerations are always listed.

HTTP Error Types

Note that since most Xignite APIs support both REST and SOAP, some of the error handling might be a bit different that what you expect from a REST calls. Please make sure to program your application accordingly.
Xignite APIs will return an HTTP status of 200 under all normal operating conditions.

See the table below for a description of the differences in behavior:

CLASS

DATA TYPES

CONTENT DETAILS

Bad Request

400

HTTP 200 Status

Outcome = RequestError

Message = Description of the error

Internal Server Error

500

HTTP 200 Status

Outcome = SystemError

Note that receiving a 500 error is still possible in the case of an unhandled exception.

Not Authorized

401

HTTP 200 Status

Outcome = RegistrationError

Message = Description of the error

Download PDF

Technical Resources Visit the page

The Code Tab provides you with many useful technical resources!

Authentication is critical. This section explains how to do it.

If you use SOAP, your SOAP toolkit will ask you the address of the WSDL for the service.

We provide customized sample code in many languages. Just cut and paste it in your code editor!

Sample Code Visit the page

Simply click on a section to see the sample code for that language.

You must do some error handling!

You could get no data back if a connectivity issue is experienced. We recommend you implement retries as well.

This critical section shows you how to pass your authentication token in the code.

You need to assess the value of the Outcome field to know if you got the right data back.

We always provide details in the Message field. You can display that field back to the user.

Deconstructing The URL

Assessing Outcome Values

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 (does not happen often).
Retry and contact support@xignite.com if it persists.

Download PDF

Managing Your Account Log into My Account

Access via this link or by clicking your e-mail address at the top right from the Xignite homepage.

Manage most account related functions including administering authentication tokens, making password changes, viewing subscription and utilization information, and adding a credit card for billing.

Download PDF

Getting Started with Xignite APIs

Getting Started