{"id":22437043,"url":"https://github.com/blockfrost/blockfrost-elixir","last_synced_at":"2025-08-01T15:31:54.033Z","repository":{"id":46828169,"uuid":"394290937","full_name":"blockfrost/blockfrost-elixir","owner":"blockfrost","description":"Elixir SDK for Blockfrost.io ","archived":false,"fork":false,"pushed_at":"2023-02-07T22:28:49.000Z","size":114,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-13T14:22:20.975Z","etag":null,"topics":["blockfrost","cardano","elixir"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blockfrost.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}},"created_at":"2021-08-09T12:55:02.000Z","updated_at":"2023-07-25T14:48:30.000Z","dependencies_parsed_at":"2023-01-23T12:31:08.840Z","dependency_job_id":null,"html_url":"https://github.com/blockfrost/blockfrost-elixir","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/blockfrost%2Fblockfrost-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fblockfrost-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fblockfrost-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blockfrost%2Fblockfrost-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blockfrost","download_url":"https://codeload.github.com/blockfrost/blockfrost-elixir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228389159,"owners_count":17912189,"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":["blockfrost","cardano","elixir"],"created_at":"2024-12-06T00:11:26.620Z","updated_at":"2024-12-06T00:11:27.413Z","avatar_url":"https://github.com/blockfrost.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![GitHub Actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fblockfrost%2Fblockfrost-elixir%2Fbadge\u0026style=flat-square)](https://github.com/blockfrost/blockfrost-elixir/actions/workflows/ci.yaml) [![Hex pm](http://img.shields.io/hexpm/dt/blockfrost.svg?style=flat)](https://hex.pm/packages/blockfrost) [![Made by Five Binaries](https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square)](https://fivebinaries.com/)\n\n\u003cimg src=\"https://blockfrost.io/images/logo.svg\" width=\"250\" align=\"right\" height=\"90\"\u003e\n\n# blockfrost-elixir\n\n\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003eElixir SDK for \u003ca href=\"https://blockfrost.io\"\u003eBlockfrost.io\u003c/a\u003e API.\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e •\n  \u003ca href=\"#shared-options\"\u003eShared Options\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr/\u003e\n\n## Installation\nTo install, add in your mix dependencies:\n\n```elixir\n{:blockfrost, \"~\u003e 0.2\"}\n```\n\nRun `mix deps.get` and see the usage section on more information about how to\n start using it.\n\n## Usage\n\u003c!-- MDOC --\u003e\nBlockfrost is an Elixir client for the Blockfrost API.\n\nEach client is a supervision tree, and you can start more than one supervision\ntree if you want to query more than a network or use more than one project.\n\nFor example, if you want to start a Cardano main net and an IPFS client:\n\n```elixir\ndefmodule MyApp.Application do\n  def start(_type, _args) do\n    children = [\n      {Blockfrost, [\n        network: :cardano_mainnet,\n        name: CardanoMainNet,\n        api_key: System.get_env(\"CARDANO_API_KEY\"),\n        retry_enabled?: true,\n        retry_max_attempts: 3\n      ]},\n      {Blockfrost, [\n        network: :ipfs,\n        name: IPFS,\n        api_key: System.get_env(\"IPFS_API_KEY\"),\n        retry_enabled?: false\n      ]}\n    ]\n\n    Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)\n  end\nend\n```\n\nThen you're ready to use your clients:\n\n```elixir\n{:ok, pools} = Blockfrost.Cardano.Pools.list_of_stake_pools(CardanoMainNet)\n```\n\n## Shared Options\n\n### Pagination Options\n\nUnless specified otherwise, all Blockfrost functions that support pagination\nsupport the following options:\n\n* `:page` - The page to be fetched. If set to `:all`, will try to fetch all\n    pages, with retries. If some of the pages fail, the first error is returned.\n    Defaults to `1`.\n* `:count` - The number of entries to be returned per page. Must be between\n    1 and 100. Defaults to `100`.\n* `:order` - The ordering of items from the point of view of the blockchain,\n    not the page listing itself. By default, Blockfrost return oldest first, \n    newest last.\n* `:max_concurrency` - If page was set to `:all`, sets how many concurrent\n  requests will be made to the Blockfrost API. Defaults to `10`.\n\n### HTTP Options\n\nAll Blockfrost API call functions support the following options:\n\n* `:retry_enabled?` - whether it should retry failing requests. \n* `:retry_max_attempts` - max retry attempts\n* `:retry_interval` - interval between attempts\n\nIf some of these options is not given, they default to the configured\nvalues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockfrost%2Fblockfrost-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblockfrost%2Fblockfrost-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblockfrost%2Fblockfrost-elixir/lists"}