{"id":16943424,"url":"https://github.com/jmettraux/figa","last_synced_at":"2026-05-18T11:01:36.259Z","repository":{"id":56846352,"uuid":"191716015","full_name":"jmettraux/figa","owner":"jmettraux","description":"Ruby client to OpenFIGI API v2","archived":false,"fork":false,"pushed_at":"2020-09-25T14:50:03.000Z","size":16,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-06T14:49:59.451Z","etag":null,"topics":["bloomberg","openfigi","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/jmettraux.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-13T07:47:56.000Z","updated_at":"2023-09-30T05:13:48.000Z","dependencies_parsed_at":"2022-09-09T01:00:19.961Z","dependency_job_id":null,"html_url":"https://github.com/jmettraux/figa","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/jmettraux/figa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Ffiga","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Ffiga/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Ffiga/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Ffiga/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmettraux","download_url":"https://codeload.github.com/jmettraux/figa/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmettraux%2Ffiga/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266947595,"owners_count":24010760,"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-07-25T02:00:09.625Z","response_time":70,"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":["bloomberg","openfigi","ruby"],"created_at":"2024-10-13T21:14:23.705Z","updated_at":"2026-05-18T11:01:31.195Z","avatar_url":"https://github.com/jmettraux.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# figa\n\n[![Gem Version](https://badge.fury.io/rb/figa.svg)](http://badge.fury.io/rb/figa)\n\nA Ruby library to query [OpenFIGI](https://www.openfigi.com/) API [v2](https://www.openfigi.com/api#v2).\n\n\n## usage\n\nInstantiate a Figa client:\n```ruby\nclient = Figa::Client.new\n  #\n  # instantiate a client without API key\n\nclient = Figa::Client.new('321456cd-af64-9932-bcbe-1a2345677999')\n  #\n  # instantiate a client with an API key\n```\n\nQuery for mappings ([/v2/mapping](https://www.openfigi.com/api#post-v2-mapping)):\n```ruby\nclient = Figa::Client.new\n\nr = client.map(isin: 'US4592001014')\n\npp r\n  # ==\u003e\n  # [{\"data\"=\u003e\n  #  [{\"figi\"=\u003e\"BBG000BLNNH6\",\n  #    \"name\"=\u003e\"INTL BUSINESS MACHINES CORP\",\n  #    \"ticker\"=\u003e\"IBM\",\n  #    \"exchCode\"=\u003e\"US\",\n  #    \"compositeFIGI\"=\u003e\"BBG000BLNNH6\",\n  #    \"uniqueID\"=\u003e\"EQ0010080100001000\",\n  #    \"securityType\"=\u003e\"Common Stock\",\n  #    \"marketSector\"=\u003e\"Equity\",\n  #    \"shareClassFIGI\"=\u003e\"BBG001S5S399\",\n  #    \"uniqueIDFutOpt\"=\u003enil,\n  #    \"securityType2\"=\u003e\"Common Stock\",\n  #    \"securityDescription\"=\u003e\"IBM\"},\n  #   {\"figi\"=\u003e\"BBG000BLNNV0\",\n  #    \"name\"=\u003e\"INTL BUSINESS MACHINES CORP\",\n  #    \"ticker\"=\u003e\"IBM\",\n  #    \"exchCode\"=\u003e\"UA\",\n  #    \"compositeFIGI\"=\u003e\"BBG000BLNNH6\",\n  #    \"uniqueID\"=\u003e\"EQ0010080100001000\",\n  #    \"securityType\"=\u003e\"Common Stock\",\n  #    \"marketSector\"=\u003e\"Equity\",\n  #    \"shareClassFIGI\"=\u003e\"BBG001S5S399\",\n  #    \"uniqueIDFutOpt\"=\u003enil,\n  #    \"securityType2\"=\u003e\"Common Stock\",\n  #    \"securityDescription\"=\u003e\"IBM\"},\n  #   ...\n\nr = client.map(isin: 'US4592001014', exchCode: 'US')\nr = client.map(idType: 'ID_ISIN', idValue: 'US4592001014', exchCode: 'US')\n\n# one can query for multiple items\nr = client.map([\n  { isin: 'US4592001014' },\n  { idType: 'ID_WERTPAPIER', idValue: '851399', exchCode: 'US' } ])\n```\n\nQuery for search ([/v2/search](https://www.openfigi.com/api#post-v2-search)):\n```ruby\nr = client.search('ibm')\nr = client.search(query: 'ibm')\nr = client.search('ibm', exchCode: 'US')\nr = client.search(query: 'ibm', exchCode: 'US')\n\npp r\n  # ==\u003e\n  # {\"data\"=\u003e\n  #   [{\"figi\"=\u003e\"BBG00196W5Z9\",\n  #     \"name\"=\u003e\"Ibm\",\n  #     \"ticker\"=\u003e\"IBMD=4\",\n  #     \"exchCode\"=\u003e\"OC\",\n  #     \"compositeFIGI\"=\u003enil,\n  #     \"uniqueID\"=\u003e\"EF12901854300074186897\",\n  #     \"securityType\"=\u003e\"DIVIDEND NEUTRAL STOCK FUTURE\",\n  #     \"marketSector\"=\u003e\"Equity\",\n  #     \"shareClassFIGI\"=\u003enil,\n  #     \"uniqueIDFutOpt\"=\u003e\"IBMD=4 OC Equity\",\n  #     \"securityType2\"=\u003e\"Future\",\n  #     \"securityDescription\"=\u003e\"IBMD=4\"},\n  #    {\"figi\"=\u003e\"BBG00196W5Y0\",\n  #     \"name\"=\u003e\"Ibm\",\n  #     \"ticker\"=\u003e\"IBMD=3\",\n  #     \"exchCode\"=\u003e\"OC\",\n  #     \"compositeFIGI\"=\u003enil,\n  #     \"uniqueID\"=\u003e\"EF12901854290074186860\",\n  #     \"securityType\"=\u003e\"DIVIDEND NEUTRAL STOCK FUTURE\",\n  #     \"marketSector\"=\u003e\"Equity\",\n  #     \"shareClassFIGI\"=\u003enil,\n  #     \"uniqueIDFutOpt\"=\u003e\"IBMD=3 OC Equity\",\n  #     \"securityType2\"=\u003e\"Future\",\n  #     \"securityDescription\"=\u003e\"IBMD=3\"},\n  #    ...\n```\n\nSearch and `#next`:\n```ruby\nr = client.search('ibm')\n  #\n  # grab the first \"page\" of results\n\nr = r.next\n  #\n  # grab the next page of results\n\n# ...\n```\n\n\n## license\n\nMIT, see [LICENSE.txt](LICENSE.txt)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmettraux%2Ffiga","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmettraux%2Ffiga","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmettraux%2Ffiga/lists"}