Example queries

As of release version 2.0, the P12 client certificate (liberator.pfx) is no longer required. The --cert-type P12 --cert liberator.pfx flags shown in the curl examples below are only needed for releases prior to 2.0.

Last known value

A query without date parameters retrieves the most recent available data.

import liberator

res = liberator.query(name='daily_bars')
df = liberator.get_dataframe(res)
df[['symbol', 'timestamp', 'open', 'high', 'low', 'close', 'volume']]

var res = liberator.query(new Dictionary<string, dynamic>() {
    {"name", "daily_bars"}
});

var df = liberator.get_dataframe(res);
Console.WriteLine(DataFrameUtils.PrettyPrint(df));

let params = {
    symbols: "AAPL",
    name:    "daily_bars"
};

liberator.query(params).then(function(results) {
    // Your code
});

Liberator liberator = new Liberator();
Object query_id = liberator.query(new HashMap<>() {{
    put("name", "daily_bars");
}});

for (Liberator.QueryResult res : liberator.Generate()) {
    Object data = res.GetData();
    if (data instanceof org.apache.arrow.vector.VectorSchemaRoot) {
        printRecordBatch((org.apache.arrow.vector.VectorSchemaRoot) data);
    } else if (data instanceof javax.json.JsonValue) {
        System.out.println((javax.json.JsonValue) data);
    }
}

print(liberator::get_dataframe(liberator::query(
    name="daily_bars"
)))

curl -qs --cert-type P12 --cert liberator.pfx \
  -H "Content-Type: application/json" --noproxy '*' \
  --data '{"json_xfer":true,"symbols":["AAPL","IBM"],"name":"daily_bars","user":"'"$USER"'","token":"'"$TOKEN"'","system":"API","debug_stream":false}' \
  $URL/liberator/query

auto table = liberator.get_table(liberator.query({
    {"name", "daily_bars"s}
}));

(void)arrow::PrettyPrint(*table, arrow::PrettyPrintOptions(0, 1), &std::cout);

Rather than displaying the entire result, you can select specific columns or pass a fields parameter to include only the data you need. Some key fields are returned automatically.

Time series queries

Two date parameters control historical data retrieval:

as_of — Retrieve data from any past date showing information as known on that date. Defaults to current time. Format: YYYY-MM-DD HH:MM:SS (time optional).
back_to — Specifies where the returned dataset begins. Reads all data “back to” the specified date. Format: YYYY-MM-DD HH:MM:SS (time optional).

If as_of and back_to are identical, the result will not be a time series.

df = liberator.get_dataframe(liberator.query(
    name='daily_bars',
    as_of='2020-11-15',
    symbols=['FB', 'AAPL', 'NFLX', 'GOOG', 'MSFT', 'IBM']))

var res = liberator.query(new Dictionary<string, dynamic>() {
    {"name", "daily_bars"},
    {"as_of", "2021-04-10"},
    {"back_to", "2021-03-10"},
    {"symbols", "ES"}
});

foreach (RecordBatch batch in res())
{
    var df = DataFrame.FromArrowRecordBatch(batch);
    Console.WriteLine(DataFrameUtils.PrettyPrint(df));
}

let params = {
    back_to: "2021-01-12 00:00:00",
    as_of:   "2021-01-12 23:59:59",
    symbols: "AAPL",
    name:    "daily_bars"
};

liberator.query(params).then(function(results) {
    // Your code
});

Object query_id = liberator.query(new HashMap<>() {{
    put("name", "daily_bars");
    put("as_of", "2020-11-15");
    put("back_to", "2020-01-01");
    put("symbols", "AAPL");
}});

for (Liberator.QueryResult res : liberator.Generate()) {
    Object data = res.GetData();
    if (data instanceof org.apache.arrow.vector.VectorSchemaRoot) {
        printRecordBatch((org.apache.arrow.vector.VectorSchemaRoot) data);
    } else if (data instanceof javax.json.JsonValue) {
        System.out.println((javax.json.JsonValue) data);
    }
}

print(liberator::get_dataframe(liberator::query(
    name="daily_bars",
    symbols="AAPL",
    as_of="2019-09-15",
    back_to="2019-09-10"
)))

curl -qs --cert-type P12 --cert liberator.pfx \
  -H "Content-Type: application/json" --noproxy '*' \
  --data '{"json_xfer":true,"symbols":"AAPL","name":"daily_bars","back_to":"2022-12-01","user":"'"$USER"'","token":"'"$TOKEN"'","system":"API","debug_stream":false}' \
  $URL/liberator/query

auto table = liberator.get_table(liberator.query({
    {"symbols", std::vector<std::string>{"AAPL", "GOOGL"}},
    {"name", "daily_bars"s},
    {"as_of", "2021-04-10"s},
    {"back_to", "2021-03-10"s}
}));

Query all symbols

Omit the symbols parameter to retrieve all symbols in a dataset.

df = liberator.get_dataframe(liberator.query(
    name='daily_bars',
    as_of='2020-11-15'))

Object query_id = liberator.query(new HashMap<>() {{
    put("name", "daily_bars");
    put("as_of", "2020-11-15");
}});

curl -qs --cert-type P12 --cert liberator.pfx \
  -H "Content-Type: application/json" --noproxy '*' \
  --data '{"json_xfer":true,"name":"daily_bars","as_of":"2020-11-15","user":"'"$USER"'","token":"'"$TOKEN"'","system":"API"}' \
  $URL/liberator/query

Query a live dataset

Set the as_of parameter to "live" for real-time data streaming.

res = liberator.query(name='live_nasdaq_composite', as_of='live')

for batch in res:
    df = batch.to_pandas()
    print(df)

var res = liberator.query(new Dictionary<string, dynamic>() {
    {"name", "live_nasdaq_composite"},
    {"as_of", "live"},
    {"symbols", "AAPL"}
});

foreach (RecordBatch batch in res())
{
    var df = DataFrame.FromArrowRecordBatch(batch);
    Console.WriteLine(DataFrameUtils.PrettyPrint(df));
}

Liberator::Result ptr = liberator.query({
    {"symbols", std::vector<std::string>{"AAPL"}},
    {"name", "live_nasdaq_composite"s},
    {"as_of", "live"s}
});

auto generator = *std::get_if<Liberator::Func>(&ptr);

for (auto res = generator(); res.index(); res = generator())
{
    auto batch = *std::get_if<2>(&res);
    (void)arrow::PrettyPrint(*batch, arrow::PrettyPrintOptions(0, 1), &std::cout);
}

Query stats as JSON

Setting the stats parameter to "total" returns a JSON result with the count per symbol instead of data rows.

res = liberator.query(
    name='daily_bars',
    as_of='2021-04-10',
    back_to='2021-03-10',
    symbols=['ES'],
    stats='total'
)

var res = liberator.query(new Dictionary<string, dynamic>() {
    {"name", "daily_bars"},
    {"as_of", "2021-04-10"},
    {"back_to", "2021-03-10"},
    {"symbols", "ES"},
    {"stats", "total"}
});
Console.WriteLine(JsonDocumentToIndentedString(res));

print(liberator::query(
    symbols="AAPL",
    name="daily_bars",
    as_of="2019-09-15",
    back_to="2019-09-10",
    stats="total"
))

Get DataFrame / table

Convert query results into a tabular format native to your language.

df = liberator.get_dataframe(
    liberator.query(name='daily_bars', as_of='2020-11-15', symbols=['AAPL'])
)

var res = liberator.query(new Dictionary<string, dynamic>() {
    {"name", "daily_bars"},
    {"as_of", "2021-04-10"},
    {"back_to", "2021-03-10"},
    {"symbols", "ES"}
});

var df = liberator.get_dataframe(res);
Console.WriteLine(DataFrameUtils.PrettyPrint(df));

res = liberator::get_dataframe(liberator::query(
    symbols="AAPL",
    name="daily_bars",
    as_of="2025-01-01",
    back_to="2024-12-01"
))

print(res)

auto table = liberator.get_table(liberator.query({
    {"symbols", std::vector<std::string>{"AAPL", "GOOGL"}},
    {"name", "daily_bars"s},
}));

(void)arrow::PrettyPrint(*table, arrow::PrettyPrintOptions(0, 1), &std::cout);

Concepts

Python

C#

JavaScript

Java

R Language

RESTful API

C++

Excel Plug-In

Example Queries

Example queries

Last known value

Time series queries

Query all symbols

Query a live dataset

Query stats as JSON

Get DataFrame / table

​Example queries

​Last known value

​Time series queries

​Query all symbols

​Query a live dataset

​Query stats as JSON

​Get DataFrame / table

Example queries

Last known value

Time series queries

Query all symbols

Query a live dataset

Query stats as JSON

Get DataFrame / table