{"id":50399124,"url":"https://github.com/parallel-7/flashforge-api-docs","last_synced_at":"2026-05-30T22:03:02.377Z","repository":{"id":294920721,"uuid":"983259297","full_name":"Parallel-7/flashforge-api-docs","owner":"Parallel-7","description":"Unofficial FlashForge API Documentation ","archived":false,"fork":false,"pushed_at":"2026-03-16T02:11:13.000Z","size":67,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-16T12:40:44.324Z","etag":null,"topics":["api","flashforge"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Parallel-7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-14T05:53:57.000Z","updated_at":"2026-03-16T02:11:16.000Z","dependencies_parsed_at":"2025-05-26T04:16:22.317Z","dependency_job_id":null,"html_url":"https://github.com/Parallel-7/flashforge-api-docs","commit_stats":null,"previous_names":["parallel-7/flashforge-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Parallel-7/flashforge-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Parallel-7%2Fflashforge-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Parallel-7%2Fflashforge-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Parallel-7%2Fflashforge-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Parallel-7%2Fflashforge-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Parallel-7","download_url":"https://codeload.github.com/Parallel-7/flashforge-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Parallel-7%2Fflashforge-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33711018,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","flashforge"],"created_at":"2026-05-30T22:03:02.245Z","updated_at":"2026-05-30T22:03:02.370Z","avatar_url":"https://github.com/Parallel-7.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FlashForge API Documentation\n\nUnofficial, community-driven documentation for FlashForge 3D printer networking protocols and APIs. Covers the Adventurer 3, Adventurer 4, Adventurer 5M, and AD5X printer families.\n\nAll documentation lives in the **[Wiki](../../wiki)**.\n\n---\n\n## Supported Printer Families\n\n| Family | Primary API | Auth | Wiki Page |\n|--------|-------------|------|-----------|\n| Adventurer 5M / 5M Pro | HTTP REST (8898) + TCP (8899) | CheckCode | [Adventurer 5M Series](../../wiki/Adventurer-5M-Series) |\n| AD5X | HTTP REST (8898) + TCP (8899) + IFS | CheckCode | [AD5X](../../wiki/AD5X) |\n| Adventurer 4 Pro / Lite | TCP (8899) | None | [Adventurer 4 Series](../../wiki/Adventurer-4-Series) |\n| Adventurer 3 Series | TCP (8899) | None | [Adventurer 3 Series](../../wiki/Adventurer-3-Series) |\n\n## Documentation\n\n### Core Protocols\n\n- **[HTTP REST API](../../wiki/HTTP-REST-API)** — JSON-based control interface on port 8898 (5M / AD5X)\n- **[TCP Protocol](../../wiki/TCP-Protocol)** — Text-based G/M-code interface on port 8899 (all models)\n- **[Discovery Protocol](../../wiki/Discovery-Protocol)** — UDP auto-discovery for finding printers on the network\n- **[Authentication](../../wiki/Authentication)** — CheckCode auth for HTTP API, open access for TCP\n\n### References\n\n- **[G-Code Reference](../../wiki/G%E2%80%90Code-Reference)** — Supported G-code commands via TCP\n- **[M-Code Reference](../../wiki/M-Code-Reference)** — Standard and proprietary FlashForge M-codes\n- **[State Machines](../../wiki/State-Machines)** — Unified state model across modern and legacy firmware\n- **[Capability Matrix](../../wiki/Capability-Matrix)** — Feature support matrix across all printer models\n- **[Error Codes](../../wiki/Error-Codes)** — HTTP, TCP, and IFS error codes with recovery strategies\n\n### Printer-Specific\n\n- **[Adventurer 5M Series](../../wiki/Adventurer-5M-Series)** — HTTP/TCP architecture, status polling, file operations\n  - **[5M Pro Features](../../wiki/Adventurer-5M-Pro-Features)** — Camera, air filtration, TVOC monitoring\n- **[AD5X](../../wiki/AD5X)** — Material station commands, manual control, extended endpoints\n  - **[IFS Material Station](../../wiki/AD5X-IFS-Material-Station)** — Multi-material slot management, load/unload, color mapping\n- **[Adventurer 4 Series](../../wiki/Adventurer-4-Series)** — TCP-only, 33 commands, Pro/Lite variant comparison\n- **[Adventurer 3 Series](../../wiki/Adventurer-3-Series)** — Legacy TCP protocol, 37 commands, 4 variant comparison\n\n### Advanced\n\n- **[AD5X Root Access](../../wiki/AD5X-Root-Access)** — Root SSH/ADB via USB firmware update mechanism\n- **[AD5X Maintenance Console](../../wiki/AD5X-Maintenance-Console)** — Hidden touchscreen debug/calibration UI\n- **[5M Maintenance Console](../../wiki/Adventurer-5M-Maintenance-Console)** — Hidden maintenance UI for 5M/5M Pro\n- **[AD5X IFS Serial Protocol](../../wiki/AD5X-IFS-Serial-Protocol)** — Raw UART protocol for the Intelligent Filament Station\n- **[AD5X Platform Notes](../../wiki/AD5X-Platform-Notes)** — Ingenic X2600 MIPS32 SoC, hardware, kernel, filesystem\n\n## Endpoint YAML Files\n\nMachine-readable endpoint specifications are available in the [`endpoints/`](endpoints/) directory:\n\n| File | Description |\n|------|-------------|\n| `endpoints_5m_3.2.7.yaml` | Adventurer 5M / 5M Pro HTTP endpoints (firmware 3.2.7) |\n| `endpoints_ad5x_1.1.7.yaml` | AD5X HTTP endpoints (firmware 1.1.7) |\n| `endpoints_ad5x_1.2.1.yaml` | AD5X HTTP endpoints (firmware 1.2.1) |\n| `networkserver_commands_adventurer3.yaml` | Adventurer 3 TCP commands |\n| `networkserver_commands_adventurer4.yaml` | Adventurer 4 TCP commands |\n\n## Methodology\n\nThis documentation is compiled from:\n\n- Firmware analysis and filesystem inspection\n- Network traffic capture and protocol analysis\n- Community testing across multiple printer models and firmware versions\n\n## Contributing\n\nContributions are welcome via pull requests. When submitting:\n\n- Specify the printer model and firmware version tested\n- Include methodology (traffic capture, binary analysis, live testing)\n- Reference specific protocol details or packet captures where possible\n\n---\n\n*This is an unofficial community project and is not affiliated with FlashForge.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallel-7%2Fflashforge-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparallel-7%2Fflashforge-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparallel-7%2Fflashforge-api-docs/lists"}