← 返回 Skills 市场

Firefly III API Client

Name: Firefly III API Client
Author: josetseph

作者 josetseph · GitHub ↗ · v1.0.5 · MIT-0

cross-platform ✓ 安全检测通过

128

总下载

当前安装

版本数

在 OpenClaw 中安装

/install firefly-iii-published

功能描述

Access and manage Firefly III finance data programmatically, including transactions, accounts, recurring rules, and automation via the API.

使用说明 (SKILL.md)

Firefly III Client Skill

Purpose

A production-ready client for Firefly III personal finance management, allowing for programmatic access to transactions, accounts, recurring rules, and automation.

Security Considerations

See SECURITY.md for information on token safety, environment variables, and network security when using this skill.

Setup

Ensure Firefly III is running and you have an OAuth Personal Access Token.

Set the following environment variables:

FIREFLY_URL=http://your-instance-url
FIREFLY_TOKEN=your_personal_access_token

Install dependencies:
```
pip install requests
```

CLI Reference

The api.py script serves as a generic wrapper for the Firefly III REST API.

python3 api.py request \x3CMETHOD> \x3CENDPOINT> [-d \x3CJSON_DATA>]

Examples

List Accounts: python3 api.py request GET api/v1/accounts
Create Transaction: python3 api.py request POST api/v1/transactions -d '{"amount": "10.00", "description": "Coffee", "source_id": 1, "destination_id": 2, "date": "2026-04-06", "type": "withdrawal"}'
Create Recurring Transaction: python3 api.py request POST api/v1/recurrences -d '{"type": "withdrawal", "title": "Example", "first_date": "2026-04-30", "repeat_freq": "monthly", "nr_of_repetitions": 12, "repetitions": [{"type": "monthly", "moment": "30"}], "transactions": [{"description": "Item", "amount": "100.00", "source_id": 1, "destination_id": 2}]}'
Create Rule: python3 api.py request POST api/v1/rules -d '{"title": "Example Rule", "trigger": "destination_account_is", "value": "Netflix", "action": "link_to_bill", "action_value": "Netflix Bill"}'

安全使用建议

This skill appears to be what it claims: a simple Firefly III API client. Before installing, ensure you: (1) only set FIREFLY_URL to a Firefly III instance you control or trust, (2) keep FIREFLY_TOKEN private (treat it like a password), (3) review the included openapi YAML if you are concerned about any documented internal hosts (it contains a 'do not use' internal URL but the code will not contact it unless you set FIREFLY_URL to that host), and (4) run the script in a trusted environment since it will perform authenticated network requests to the URL you supply. Also note the manifest version mismatch (1.0.3 vs registry 1.0.5) — this is likely harmless metadata drift but you may want to confirm you have the intended release.

功能分析

Package: firefly-iii (xpi) Version: 1.0.3 Description: API client for Firefly III personal finance management. View accounts and transactions. The package is a standard API client for Firefly III, a personal finance management system. The source code consists of a Python script (src/api.py) that provides a command-line interface for making REST API requests to a user-specified Firefly III instance. It uses the 'requests' library for network communication and retrieves authentication credentials (URL and Token) from environment variables as documented. There is no evidence of malicious behavior such as secret exfiltration, unauthorized binary execution, or hidden payload downloads.

能力标签

cryptocan-make-purchasesrequires-oauth-token

能力评估

✓ Purpose & Capability

Name/description, manifest, SKILL.md, and src/api.py all align: the skill implements a generic REST wrapper for Firefly III and requires FIREFLY_URL and FIREFLY_TOKEN. The declared capability (network.external) and the dependency on 'requests' are appropriate for this purpose. Minor metadata drift: manifest version (1.0.3) differs from registry version (1.0.5), which is a bookkeeping inconsistency but not a functional mismatch.

✓ Instruction Scope

SKILL.md directs the agent to set FIREFLY_URL and FIREFLY_TOKEN, install requests, and run api.py with explicit commands. The runtime instructions do not ask the agent to read unrelated files, system secrets, or transmit data to endpoints other than the configured FIREFLY_URL. The included SECURITY.md correctly warns about token safety.

✓ Install Mechanism

There is no automated install spec; the skill is instruction-only with an included Python script. Dependencies are modest (requests) and correctly declared in manifest. No external downloads or archive extraction are performed by the skill files.

✓ Credentials

The only environment variables declared and used are FIREFLY_URL and FIREFLY_TOKEN, which are necessary and proportionate for an API client. The code only reads those two variables and uses them to form authenticated requests.

✓ Persistence & Privilege

always is false and the skill does not request persistent system privileges or alter other skills or system configs. It performs network calls only to the user-provided FIREFLY_URL when invoked.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install firefly-iii-published
安装完成后，直接呼叫该 Skill 的名称或使用 /firefly-iii-published 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.5

- Maintenance release with internal code changes in src/api.py. - No user-facing features or documentation updates.

v1.0.4

- Internal code changes made in src/api.py; user-facing functionality and documentation remain unchanged. - No updates to setup, usage examples, or CLI interface.

v1.0.3

- Updated manifest.json with minor adjustments (details not specified). - No changes to functionality or documentation were made. - Existing API usage and setup instructions remain unchanged.

v1.0.2

- Updated manifest.json file for improved configuration or compatibility. - No user-facing changes to functionality or documentation. - Maintained all instructions and CLI usage as in the previous version.

v1.0.1

- Added SECURITY.md with important security considerations. - Updated SKILL.md to reference SECURITY.md and highlight token, environment, and network security.

v1.0.0

Initial release of Firefly III Client Skill: - Provides a production-ready client for Firefly III personal finance management. - Enables programmatic access to transactions, accounts, recurring rules, and automation. - Includes a CLI wrapper (`api.py`) for making generic API requests. - Supports OAuth Personal Access Token authentication via environment variables. - Offers clear setup instructions and usage examples for common financial operations.

元数据

Slug firefly-iii-published

版本 1.0.5

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 6

常见问题