Using Apperate’s APIs#

Apperate’s APIs are based on REST, have resource-oriented URLs, and return JSON-encoded responses and standard HTTP response codes.

The Apperate API Reference (https://iexcloud.io/docs/) site provides the reference documentation and a Getting Started guide.

Here’s a screenshot of the Getting Started guide and the API Reference navigation:

The Getting Started guide is the best place to start learning the API fundamentals.

The tutorials here in this site compliment the Getting Started guide and API Reference by demonstrating how to complete different tasks using the APIs.

Here are some of the task areas and links to related tutorials and API Reference pages.

Querying Data#

The Data API’s GET /data endpoint returns data from the dataset you specify. The endpoint supports using windowing functions for Querying Datasets. The Datasets pages and Core Data pages describe each dataset’s GET /data endpoint parameters and response attributes.

Important

Apperate includes only historical time series Core Data at this time. We are in the process of migrating real-time legacy data, including stock quotes, into Apperate. In the meantime, please see the Legacy API Reference for the real-time legacy data.

The Example Request on each dataset’s Overview page demonstrates using the GET /data endpoint on that dataset.

Querying Datasets demonstrates applying windowing functions to the queries.

The API Reference’s IEX Exchange, and Miscellaneous, and Reference Data pages describe getting Core Data that is not time series.

Other Data Operations#

Data API instructions for the create, update, and delete operations accompany this article’s CRUD-related sibling articles.

Getting an API OAS Document#

The GET /openapi-doc endpoint returns a JSON file that specifies the Apperate APIs per the OpenAPI Specification (OAS). You can generate a client SDK for your favorite language using the JSON file.

What’s Next#

As mentioned above, a great way to learn the APIs is by following the API Reference’s Getting Started guide and digesting the short articles that follow it. Then work with the data and data-related entities as demonstrated in the articles mentioned above.