{"id":37135786,"url":"https://github.com/mrz1836/go-bitindex","last_synced_at":"2026-01-14T15:50:03.184Z","repository":{"id":71207788,"uuid":"217591140","full_name":"mrz1836/go-bitindex","owner":"mrz1836","description":":minidisc: Unofficial golang implementation for the BitIndex API","archived":true,"fork":false,"pushed_at":"2021-08-06T17:45:58.000Z","size":171,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-20T13:41:04.169Z","etag":null,"topics":["api","bitcoin","bitcoinsv","bitindex","bitindex-api","bsv","go","golang","gomod","gomodule","xpub"],"latest_commit_sha":null,"homepage":"https://www.bitindex.network/developers/api-documentation-v3.html","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/mrz1836.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"mrz1836","custom":"https://mrz1818.com/?tab=tips\u0026af=go-bitindex"}},"created_at":"2019-10-25T18:16:57.000Z","updated_at":"2024-01-02T14:58:40.000Z","dependencies_parsed_at":"2024-06-20T13:09:10.032Z","dependency_job_id":"1b1a8b4f-759f-4eaf-92cd-d7c5803acb9e","html_url":"https://github.com/mrz1836/go-bitindex","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/mrz1836/go-bitindex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrz1836%2Fgo-bitindex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrz1836%2Fgo-bitindex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrz1836%2Fgo-bitindex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrz1836%2Fgo-bitindex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrz1836","download_url":"https://codeload.github.com/mrz1836/go-bitindex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrz1836%2Fgo-bitindex/sbom","scorecard":{"id":665022,"data":{"date":"2025-08-11","repo":{"name":"github.com/mrz1836/go-bitindex","commit":"ab384c5791f5b8eeff313f10c628504fc864c09a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/run-tests.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/run-tests.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/run-tests.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/sync-labels.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mrz1836/go-bitindex/sync-labels.yml/master?enable=pin","Warn: downloadThenRun not pinned by hash: .github/workflows/run-tests.yml:44","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":10,"reason":"SAST tool detected: CodeQL","details":["Info: SAST configuration detected: CodeQL","Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/run-tests.yml:1","Warn: no topLevel permission defined: .github/workflows/sync-labels.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0603 / GHSA-hp87-p4gw-j4gq"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T17:42:58.049Z","repository_id":71207788,"created_at":"2025-08-21T17:42:58.049Z","updated_at":"2025-08-21T17:42:58.049Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28425148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T15:24:48.085Z","status":"ssl_error","status_checked_at":"2026-01-14T15:23:41.940Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","bitcoin","bitcoinsv","bitindex","bitindex-api","bsv","go","golang","gomod","gomodule","xpub"],"created_at":"2026-01-14T15:50:02.435Z","updated_at":"2026-01-14T15:50:03.165Z","avatar_url":"https://github.com/mrz1836.png","language":"Go","funding_links":["https://github.com/sponsors/mrz1836","https://mrz1818.com/?tab=tips\u0026af=go-bitindex"],"categories":[],"sub_categories":[],"readme":"# go-bitindex\n\u003e The unofficial Go implementation for the [BitIndex API](https://www.bitindex.network/developers/api-documentation-v3.html)\n\n\u003cbr/\u003e\n\n[![Release](https://img.shields.io/github/release-pre/mrz1836/go-bitindex.svg?logo=github\u0026style=flat\u0026v=2)](https://github.com/mrz1836/go-bitindex/releases)\n[![Build Status](https://img.shields.io/github/workflow/status/mrz1836/go-bitindex/run-go-tests?logo=github\u0026v=3)](https://github.com/mrz1836/go-bitindex/actions)\n[![Report](https://goreportcard.com/badge/github.com/mrz1836/go-bitindex?style=flat\u0026v=1)](https://goreportcard.com/report/github.com/mrz1836/go-bitindex)\n[![Go](https://img.shields.io/github/go-mod/go-version/mrz1836/go-bitindex)](https://golang.org/)\n[![Sponsor](https://img.shields.io/badge/sponsor-MrZ-181717.svg?logo=github\u0026style=flat\u0026v=3)](https://github.com/sponsors/mrz1836)\n[![Donate](https://img.shields.io/badge/donate-bitcoin-ff9900.svg?logo=bitcoin\u0026style=flat)](https://mrz1818.com/?tab=tips\u0026af=go-bitindex)\n\n\u003cbr/\u003e\n\n## Table of Contents\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Examples \u0026 Tests](#examples--tests)\n- [Benchmarks](#benchmarks)\n- [Code Standards](#code-standards)\n- [Usage](#usage)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003cbr/\u003e\n\n## Installation\n\n**go-bitindex** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).\n```shell script\ngo get -u github.com/mrz1836/go-bitindex\n```\n\n\u003cbr/\u003e\n\n## Documentation\nView the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-bitindex)\n\n[![GoDoc](https://godoc.org/github.com/mrz1836/go-bitindex?status.svg\u0026style=flat)](https://pkg.go.dev/github.com/mrz1836/go-bitindex)\n\nYou can also view the [BitIndex api](https://www.bitindex.network/developers/api-documentation-v3.html) documentation.\n\n### Features\n- Supports \u003e= V3 API requests\n- [Client](client.go) is completely configurable\n- Customize the network per request (`main`, `test` or `stn`)\n- Using [heimdall http client](https://github.com/gojek/heimdall) with exponential backoff \u0026 more\n- Current (V3) coverage for the [BitIndex](https://developers.bitindex.com/) API\n    - [x] Address\n    - [x] Block\n    - [x] Chain Info\n    - [x] Transaction\n    - [x] Webhooks\n    - [x] Xpub\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eLibrary Deployment\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\n[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.\n\nThe [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).\n\nUse `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eMakefile Commands\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nView all `makefile` commands\n```shell script\nmake help\n```\n\nList of all current commands:\n```text\nall                  Runs lint, test-short and vet\nclean                Remove previous builds and any test cache data\nclean-mods           Remove all the Go mod cache\ncoverage             Shows the test coverage\ngodocs               Sync the latest tag with GoDocs\nhelp                 Show this help message\ninstall              Install the application\ninstall-go           Install the application (Using Native Go)\nlint                 Run the golangci-lint application (install if not found)\nrelease              Full production release (creates release in Github)\nrelease              Runs common.release then runs godocs\nrelease-snap         Test the full release (build binaries)\nrelease-test         Full production test release (everything except deploy)\nreplace-version      Replaces the version in HTML/JS (pre-deploy)\nrun-examples         Runs all the examples\ntag                  Generate a new tag and push (tag version=0.0.0)\ntag-remove           Remove a tag if found (tag-remove version=0.0.0)\ntag-update           Update an existing tag to current commit (tag-update version=0.0.0)\ntest                 Runs vet, lint and ALL tests\ntest-ci              Runs all tests via CI (exports coverage)\ntest-ci-no-race      Runs all tests via CI (no race) (exports coverage)\ntest-ci-short        Runs unit tests via CI (exports coverage)\ntest-short           Runs vet, lint and tests (excludes integration tests)\nuninstall            Uninstall the application (and remove files)\nupdate-linter        Update the golangci-lint package (macOS only)\nvet                  Run the Go vet application\n```\n\u003c/details\u003e\n\n\u003cbr/\u003e\n\n## Examples \u0026 Tests\nAll unit tests and [examples](examples) run via [Github Actions](https://github.com/mrz1836/go-bitindex/actions) and\nuses [Go version 1.15.x](https://golang.org/doc/go1.15). View the [configuration file](.github/workflows/run-tests.yml).\n\nExamples \u0026 Tests by API section:\n- [address](address_test.go)\n- [block](block_test.go)\n- [chain](chain_test.go)\n- [transaction](transaction_test.go)\n- [webhook](webhook_test.go)\n- [xpub](xpub_test.go)\n\nRun all tests (including integration tests)\n```shell script\nmake test\n```\n\nRun tests (excluding integration tests)\n```shell script\nmake test-short\n```\n\n\u003cbr/\u003e\n\n## Benchmarks\nRun the Go [benchmarks](bitindex_test.go):\n```shell script\nmake bench\n```\n\n\u003cbr/\u003e\n\n## Code Standards\nRead more about this Go project's [code standards](CODE_STANDARDS.md).\n\n\u003cbr/\u003e\n\n## Usage\nView the [bitindex examples](#examples--tests) above\n\nBasic implementation:\n```go\npackage main\n\nimport (\n\t\"log\"\n\n\t\"github.com/mrz1836/go-bitindex\"\n)\n\nfunc main() {\n\n\t// Create a new client\n\tclient, _ := bitindex.NewClient(\"your-secret-api-key\", bitindex.NetworkMain, nil)\n\n\t// Get balance for an address\n\tinfo, _ := client.AddressInfo(\"16ZqP5Tb22KJuvSAbjNkoiZs13mmRmexZA\")\n\n\t// What's the balance?\n\tlog.Println(\"address balance:\", info.Balance)\n}\n```\n\n\u003cbr/\u003e\n\n## Maintainers\n| [\u003cimg src=\"https://github.com/mrz1836.png\" height=\"50\" alt=\"MrZ\" /\u003e](https://github.com/mrz1836) |\n|:---:|\n| [MrZ](https://github.com/mrz1836) |\n\n\u003cbr/\u003e\n\n## Contributing\nView the [contributing guidelines](CONTRIBUTING.md) and follow the [code of conduct](CODE_OF_CONDUCT.md).\n\n### How can I help?\nAll kinds of contributions are welcome :raised_hands:! \nThe most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. \nYou can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap: \nor by making a [**bitcoin donation**](https://mrz1818.com/?tab=tips\u0026af=go-bitindex) to ensure this journey continues indefinitely! :rocket:\n\n\n#### Credits\n[@Attila](https://github.com/attilaaf) \u0026 [BitIndex](https://www.bitindex.network/) for their hard work on the [BitIndex API](https://www.bitindex.network/developers/api-documentation-v3.html)\n\nLooking for a Javascript version? Check out the [BitIndex JS SDK](https://github.com/BitIndex/bitindex-sdk)\n\nLooking for MatterCloud? Checkout the [go-mattercloud](https://github.com/mrz1836/go-mattercloud) package.\n\n\u003cbr/\u003e\n\n## License\n\n![License](https://img.shields.io/github/license/mrz1836/go-bitindex.svg?style=flat\u0026v=1)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrz1836%2Fgo-bitindex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrz1836%2Fgo-bitindex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrz1836%2Fgo-bitindex/lists"}