Documentation

There are several ways to interface with Datamule's API.

  1. datamulehub - newer package, currently being polished. Python, TypeScript.
  2. datamule - old package. Deprecated, but often useful for new projects. Python

This documentation will only focus on datamulehub. Note that the Typescript package is a LLM port.

Installation

pip install datamule-hub

API Key

You can set DATAMULE_API_KEY to your environment, or pass api_key to function calls.

JavaScript uses the same function names, with keyword arguments passed in an options object.

Logging

Python datamulehub hides logs by default. To enable:

import logging

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s %(levelname)s %(message)s",
)

JavaScript logs automatically through console.info(). No configuration is required.

Important times

Datamule updates instantly, as new filings are released. At 06:00 UTC Tuesday–Saturday, processed datasets (e.g. XBRL) are combined and sorted. This is to reduce cost to download and query them. This is 1-2AM ET depending on Daylight Savings. We recommend if you want to refesh data at a daily interval, to pull after 09:00 UTC.

Todo