Skip to main content

Python client for the Furnilytics API (topic/subtopic/dataset).

Project description

furnilytics

Pandas-first client for the Furnilytics API with hierarchy topic / subtopic / dataset.

  • Base URL is hardcoded to: https://furnilytics-api.fly.dev
  • Authentication via header X-API-KEY (set FURNILYTICS_API_KEY env var or pass api_key=).

Install (editable for local dev)

pip install -e .

Quick start

import os
import pandas as pd
from furnilytics import Client

os.environ["FURNILYTICS_API_KEY"] = "your_key_here"

cli = Client()  # base_url is fixed to https://furnilytics-api.fly.dev

# Discover
topics_df = cli.list_topics()              # topic-level (one row per subtopic entry)
flat_df   = cli.list_datasets_flat()       # all datasets with topic/subtopic
print(topics_df.head()); print(flat_df.head())

# Inspect dataset
meta_df, columns_df = cli.dataset_info("prices","panels","woodbased_panels_ppi")
print(meta_df); print(columns_df)

# Query rows (DataFrame)
df = cli.get("prices","panels","woodbased_panels_ppi", limit=5, country="SE")
print(df)

# Select, order, date window (if dataset has time_column)
df2 = cli.get("prices","panels","woodbased_panels_ppi",
              select=["date","ppi","country"],
              order_by="date", order_dir="DESC",
              frm="2022-01-01", to="2023-12-31",
              country="SE", limit=100)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

furnilytics-0.1.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

furnilytics-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file furnilytics-0.1.0.tar.gz.

File metadata

  • Download URL: furnilytics-0.1.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for furnilytics-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d612660b37259c40bee79d945d8eadbe2745d2b4820706c925a339ed5b199ffa
MD5 afd1643626595b3280bc3646d8c8d14c
BLAKE2b-256 91533b82d4b5de8eff30298f4c9bf4ebb3ff20ca1cb5e808c570378be45c1cfe

See more details on using hashes here.

File details

Details for the file furnilytics-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: furnilytics-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for furnilytics-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 456d19a24092e5b8b9c10007e078ffd6b33829bb02823fc3d5950e6f74c5da35
MD5 434e0f55d6cd2480024a71ea511c681b
BLAKE2b-256 c15b9090a6f6074600a4333f6d254be717814ba0a3b0359e3ab83f5cf3d2facd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page