{"id":16154224,"url":"https://github.com/omani/nkn-openapi-client","last_synced_at":"2025-08-01T04:34:27.832Z","repository":{"id":185993942,"uuid":"674020912","full_name":"omani/nkn-openapi-client","owner":"omani","description":"A client library for the NKN OpenAPI written in go","archived":false,"fork":false,"pushed_at":"2023-08-05T14:58:45.000Z","size":298,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-11T10:13:29.115Z","etag":null,"topics":["client","go","golang","nkn","openapi","resty"],"latest_commit_sha":null,"homepage":"https://nkn.org/","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/omani.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":"2023-08-03T01:00:18.000Z","updated_at":"2023-08-10T17:02:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"75f7754d-30e3-421a-8625-44628cece964","html_url":"https://github.com/omani/nkn-openapi-client","commit_stats":null,"previous_names":["omani/nkn-openapi-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/omani/nkn-openapi-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omani%2Fnkn-openapi-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omani%2Fnkn-openapi-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omani%2Fnkn-openapi-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omani%2Fnkn-openapi-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omani","download_url":"https://codeload.github.com/omani/nkn-openapi-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omani%2Fnkn-openapi-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268171063,"owners_count":24207409,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"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":["client","go","golang","nkn","openapi","resty"],"created_at":"2024-10-10T01:15:38.650Z","updated_at":"2025-08-01T04:34:27.809Z","avatar_url":"https://github.com/omani.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"media/logo.png\" width=\"150\"\u003e\u003c/p\u003e\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/omani/nkn-openapi-client.svg)](https://pkg.go.dev/github.com/omani/nkn-openapi-client)\n\n# nkn-openapi-client\nA client library for the [NKN OpenAPI](https://github.com/rule110-io/nkn-open-api) written in go\n\n\u003e NKN OpenAPI is an NKN blockchain database abstraction with a neat query interface.\n\n## Example\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\n\tclient \"github.com/omani/nkn-openapi-client\"\n)\n\nfunc checkerr(err error) {\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n}\n\nfunc main() {\n\tc := client.New()\n\tc.SetAddress(\"https://openapi.nkn.org/api/v1\")\n\n\tresp, err := c.GetRegisteredNames()\n\tcheckerr(err)\n\n\tfor _, n := range resp.Data {\n\t\tfmt.Println(n.Name)\n\t}\n\n\tif !resp.HasMore() {\n\t\treturn\n\t}\n\t// we have more than one page. fetch one more page.\n\terr = c.Next(resp)\n\tcheckerr(err)\n\n\tfor _, n := range resp.Data {\n\t\tfmt.Println(n.Name)\n\t}\n}\n```\n\nUnit tests are available in `client_test.go`:\n\nRun the tests in the root of the repository with `go test`.\n\n\n### This repository comes with a simple example CLI app in `cmd/`.\n\n---\n\n## CLI App\n\n### Install\n`go install github.com/omani/nkn-openapi-client/cmd/nkn-openapi-client@latest`\n\n\n### Usage\n#### Clone this repository\n`git clone https://github.com/omani/nkn-openapi-client`\n\n#### Show transactions of an NKN wallet address:\n```\ncd cmd/nkn-openapi-client/\ngo run main.go transactions --address NKNJ6Tka2rcrqT4FPJTjfoWQLjvahctSiyRF\n```\n\nOutput:\n\u003cp\u003e\u003cimg src=\"media/shot.png\"\u003e\u003c/p\u003e\n\n\n#### Show transactions with a given hash\n```\ncd cmd/nkn-openapi-client/\ngo run main.go transactions --hash 993a8f8ec9ca3a295e8873c573759d11b844c698e0e50f4edd1fa50751c2d879\n```\n\n#### Show block at a given height\n```\ncd cmd/nkn-openapi-client/\ngo run main.go blocks --height 5648381\n```\n\n#### Show block with a given hash\n```\ncd cmd/nkn-openapi-client/\ngo run main.go blocks --hash 0d48328a5005e7455c6a5e2a0b5bc346b09fbae129f1775589be83657850656a\n```\n\n#### Use your own NKN OpenAPI instance by providing a `--url` flag\n```\ncd cmd/nkn-openapi-client/\ngo run main.go --url https://my-own-nkn-openapi.tld blocks --hash 0d48328a5005e7455c6a5e2a0b5bc346b09fbae129f1775589be83657850656a\n```\n\n---\n\n# Contribution\n* You can fork this, extend it and contribute back.\n* You can contribute with pull requests.\n\n# Donations\nI accept payments and donations in BTC:\n\n\u003cimg src=\"https://raw.githubusercontent.com/bitpay/bitcoin-brand/master/bitcoin.svg\" width=\"16\" height=\"16\" /\u003e `bc1qgezvfp4s0xme8pdv6aaqu9ayfgnv4mejdlv3tx`\n\n# LICENSE\nMIT License\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomani%2Fnkn-openapi-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomani%2Fnkn-openapi-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomani%2Fnkn-openapi-client/lists"}