{"id":26824270,"url":"https://github.com/tomy2e/livebox-api-client","last_synced_at":"2025-09-15T00:17:16.509Z","repository":{"id":57636023,"uuid":"426406667","full_name":"Tomy2e/livebox-api-client","owner":"Tomy2e","description":"A Go client library for Livebox's API","archived":false,"fork":false,"pushed_at":"2024-08-09T16:05:55.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-10T12:37:40.546Z","etag":null,"topics":["api","client","go","livebox"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/Tomy2e/livebox-api-client","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tomy2e.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-11-09T22:29:22.000Z","updated_at":"2024-08-09T16:05:58.000Z","dependencies_parsed_at":"2024-08-09T12:43:58.616Z","dependency_job_id":null,"html_url":"https://github.com/Tomy2e/livebox-api-client","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomy2e%2Flivebox-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomy2e%2Flivebox-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomy2e%2Flivebox-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tomy2e%2Flivebox-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tomy2e","download_url":"https://codeload.github.com/Tomy2e/livebox-api-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246296943,"owners_count":20754708,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","client","go","livebox"],"created_at":"2025-03-30T09:19:28.046Z","updated_at":"2025-03-30T09:19:28.568Z","avatar_url":"https://github.com/Tomy2e.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Livebox API client\n\nThis Go library makes it easy to communicate with Livebox's API. This API is\nusually available at `http://192.168.1.1/ws`. Authentication is handled by\nthe library, set the `admin` password and start sending requests.\n\nIt was tested with a Livebox 5. Other Livebox models might not be supported.\n\n## Usage\n\nGet the library by running the following command:\n\n```console\ngo get -u github.com/Tomy2e/livebox-api-client\n```\n\nImport the library in your source file:\n\n```golang\nimport \"github.com/Tomy2e/livebox-api-client\"\nimport \"github.com/Tomy2e/livebox-api-client/api/request\"\n```\n\nCreate a new client:\n\n```golang\n// Client with default HTTP client\nclient, _ := livebox.NewClient(\"\u003cadmin-password\u003e\")\n\n// Client with custom HTTP client\nclient, _ := livebox.NewClient(\"\u003cadmin-password\u003e\", livebox.WithHTTPClient(\u0026http.Client{}))\n```\n\nSend requests using the client:\n\n```golang\nvar r json.RawMessage\n\n_ = client.Request(\n    context.Background(),\n    request.New(\"TopologyDiagnostics\", \"buildTopology\", map[string]interface{}{\"SendXmlFile\": false}),\n    \u0026r,\n)\n\nfmt.Println(string(r))\n```\n\n## Livebox CLI Usage\n\nThe `livebox-cli` tool allows to easily send requests to the Livebox API. It writes the JSON responses to stdout.\n\nPre-built binaries are available in the [Releases](https://github.com/Tomy2e/livebox-api-client/releases) section.\nIf you have Go installed, you can run it with:\n\n```console\ngo run github.com/Tomy2e/livebox-api-client/cmd/livebox-cli@main\n```\n\n### Options\n\nThe tool accepts the following command-line options:\n\n| Name     | Description                  | Default value |\n| -------- | ---------------------------- | ------------- |\n| -service | Livebox service              |               |\n| -method  | Method to use                |               |\n| -params  | Optional JSON-encoded params |               |\n\nThe tool reads the following environment variables:\n\n| Name           | Description                           | Default value |\n| -------------- | ------------------------------------- | ------------- |\n| ADMIN_PASSWORD | Password of the Livebox \"admin\" user. |               |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomy2e%2Flivebox-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomy2e%2Flivebox-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomy2e%2Flivebox-api-client/lists"}