Get Started with Apperate#

A great way to get familiar with Apperate is to write data to it and access that data. Apperate stores data in datasets; they’re schema-based database tables that come with additional benefits. Datasets can store any data model, and are optimized for time series data. For each dataset, Apperate automatically generates a permissioned API and API docs.

Here’s how we’ll get started with Apperate:

  1. Create a workspace

  2. Load data and generate a dataset for it in one step

  3. Read data from the dataset endpoint

Attention

If you don’t already have an IEX Cloud Apperate account, create one here.

Create a Workspace#

A workspace is your unique domain for writing data to Apperate and querying data (your data and Apperate’s built-in core financial data) from Apperate. Your workspace name appears in your Base URL.

Base URL Format:

https://WORKSPACE.iex.cloud/v1

Base URL Example:

https://mycompany.iex.cloud/v1

Workspace name mycompany in the URL above, is the subdomain of iex.cloud.

Important

The workspace name is permanent, so make sure to name it exactly how you want it.

Create your workspace:

  1. Click on the link in your invitation email. The Create a Workspace page appears.

  2. Name your workspace and agree to the terms when you’re ready. Then create your workspace by clicking Submit. The Create a dataset page appears.

Your workspace is ready for storing new data and accessing built-in Core Financial Data! It’s time to load some data into Apperate.

Load Data in One Step#

Here you will create a dataset from a data file.

Note

If you’re not already in the Create a dataset page, click Create a dataset at the top right of the console.

On the Create a dataset page, name your dataset and keep the source type set to Local file. Load the sample data file by clicking Try using our sample file.

Your new dataset’s Overview page appears.

See also

For Overview page details, see Dataset Overview Page reference.

Let’s test drive the dataset by reading data from it.

Read the Data#

From the Overview page, read data from your new dataset by clicking the Example request URL.

The URL opens in a new browser tab and the request returns a JSON object containing the dataset’s last record.

[
    {
        "close": 148.64,
        "date": "2021-10-25",
        "high": 149.37,
        "low": 147.6211,
        "open": 148.68,
        "symbol": "AAPL",
        "volume": 50720556
    }
]

Tip

The Example request URL uses the Data API. You can use the URL as a base on which to query the dataset using other parameters and values. See Querying Datasets for examples.

Visit Your API Docs#

From the Overview page, you can visit your dataset API docs by clicking Open Docs. Your API docs page, like the one shown below, opens in a new tab.

Your auto-documented dataset is ready for consumption.

You just loaded data into Apperate and retrieved a record from the dataset using the dataset’s API! It’s just that easy to store data in Apperate and make that data available to your apps!!

What’s Next#

After creating a dataset, you can edit its schema however you like. For more information on managing datasets, please see Understanding Datasets.

Here are key features to dive into next: