Skip to main content

tap-hotmart

PyPI version Python License Singer SDK

A Singer tap for the Hotmart API, built with the Meltano Singer SDK.

Extracts sales, subscriptions, commissions, and product data from Hotmart and delivers it as a standard Singer stream — ready to load into any data warehouse (Postgres, BigQuery, Snowflake, etc.) or consumed by any Singer-compatible target.

Relationship with hotmart-python

This tap is built on top of hotmart-python, a Python SDK for the Hotmart API maintained by the same author. Both projects are developed in tandem:

  • hotmart-python handles authentication, pagination, retry, rate limiting, and API model definitions
  • tap-hotmart handles Singer protocol compliance: schema emission, incremental state, and record extraction

Whenever hotmart-python adds support for a new Hotmart API endpoint or model, a corresponding stream is added here. The two projects share the same release cadence.

Streams

Stream Replication Primary Key Description
transactions INCREMENTAL (approved_date) transaction Full sales history with buyer, product, payment, and fee details
subscriptions INCREMENTAL (accession_date) subscriber_code Subscription records with plan, status, and next charge date
commissions FULL_TABLE transaction Per-sale commission breakdown by role (producer, co-producer, affiliate)
products FULL_TABLE product_id Products registered in the account

Notes:

  • transactions and subscriptions are incremental: on each run, only records newer than the last bookmark are fetched.
  • commissions is full table because the Hotmart API does not expose a date field in commission responses, making reliable incremental extraction impossible. It is re-fetched in full on every run.
  • All incremental streams use automatic date chunking (30-day windows) to stay within Hotmart's per-request date range limits, so any start_date works without manual configuration.

Requirements

Installation

pip install tap-hotmart

Configuration

Create a config.json file:

{
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "basic": "Basic <your-base64-token>",
  "start_date": "2021-01-01T00:00:00Z",
  "sandbox": false
}
Setting Required Default Description
client_id ✅ — Hotmart API Client ID
client_secret ✅ — Hotmart API Client Secret
basic ✅ — Basic <base64(client_id:client_secret)> — available directly in the Hotmart Developer Portal
start_date ✅ — Earliest record date to sync (ISO 8601). Set to whenever you first started using Hotmart.
sandbox — false Use the Hotmart sandbox environment

Note: The basic token is the Base64 encoding of client_id:client_secret. The Hotmart Developer Portal shows this value ready to copy — it starts with Basic .

Usage

# Discover available streams
tap-hotmart --config config.json --discover

# Sync all streams to stdout
tap-hotmart --config config.json

# Pipe to a Singer target
tap-hotmart --config config.json | target-jsonl --config target-config.json

# Incremental run with state
tap-hotmart --config config.json --state state.json \
  | target-postgres --config target-config.json \
  | tail -1 > state.json

Usage with Meltano

meltano add extractor tap-hotmart --variant im-voracity
meltano config tap-hotmart set client_id "your-client-id"
meltano config tap-hotmart set client_secret "your-client-secret"
meltano config tap-hotmart set basic "Basic <your-base64-token>"
meltano config tap-hotmart set start_date "2021-01-01T00:00:00Z"

meltano run tap-hotmart <your-target>

Development

git clone https://github.com/im-voracity/tap-hotmart
cd tap-hotmart
uv sync
uv run pytest tests/
uv run ruff check .
uv run mypy tap_hotmart/

To run tests against the live API, add a config.json with real credentials at the repo root. The test suite detects it automatically and runs the full Singer compliance suite (test_core.py) against the real API. Without config.json, all live tests are skipped and only unit/mock tests run.

Contributing

Bug reports and pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Author

Maintained by Matheus Tenório. Also the author of hotmart-python, the underlying SDK this tap depends on.

License

Apache 2.0

Metadata

Release files for tap-hotmart 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tap-hotmart 1.0.0
File Size Uploaded
tap_hotmart-1.0.0.tar.gz 17.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tap-hotmart 1.0.0
File Interpreter ABI Platform
tap_hotmart-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 32.0 kB

Release files / tap_hotmart-1.0.0.tar.gz

Download URL tap_hotmart-1.0.0.tar.gz
Size 17.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e386f27a7cca0138dfb1156e1abe248d6df78764db21df5c095fe88a4161ae8f
BLAKE2b-256 checksum
How to use checksums
161ee84c88205109bd1d725f899514b0498fafd205d4de405a771f778bf469bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / tap_hotmart-1.0.0-py3-none-any.whl

Download URL tap_hotmart-1.0.0-py3-none-any.whl
Size 14.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5161b2afa1e077757b954fc45d0f945bad5d84a3b3d3f88f8209572d3c3337f8
BLAKE2b-256 checksum
How to use checksums
fdd58da9739acfa9c2a21065435909d87455a4681e0346e317ce144a7e049675
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page