{"id":29679417,"url":"https://github.com/speciesfilegroup/syconium","last_synced_at":"2025-07-23T01:07:01.089Z","repository":{"id":304240783,"uuid":"1018231897","full_name":"SpeciesFileGroup/syconium","owner":"SpeciesFileGroup","description":"Ruby wrapper for the OpenAlex API","archived":false,"fork":false,"pushed_at":"2025-07-11T21:55:27.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-11T22:06:25.816Z","etag":null,"topics":[],"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/SpeciesFileGroup.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2025-07-11T20:59:20.000Z","updated_at":"2025-07-11T21:48:41.000Z","dependencies_parsed_at":"2025-07-11T22:06:34.642Z","dependency_job_id":null,"html_url":"https://github.com/SpeciesFileGroup/syconium","commit_stats":null,"previous_names":["speciesfilegroup/syconium"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/SpeciesFileGroup/syconium","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fsyconium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fsyconium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fsyconium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fsyconium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpeciesFileGroup","download_url":"https://codeload.github.com/SpeciesFileGroup/syconium/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fsyconium/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266598374,"owners_count":23953953,"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-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2025-07-23T01:06:44.270Z","updated_at":"2025-07-23T01:07:01.043Z","avatar_url":"https://github.com/SpeciesFileGroup.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Syconium\n\nSyconium is a Ruby wrapper on the [OpenAlex](https://openalex.org) API. Code follow the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'syconium'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install syconium\n\n## Usage\n\nTo use the OpenAlex API via the Syconium Ruby gem, you must supply either your email address or your api_key. Providing your email helps OpenAlex get in touch with your if there is a problem with your software.\n\n### Pagination\n\nFor pagination, you can browse up to 10,000 results with the page and per_page parameters:\n```ruby\nSyconium.works(email: \"your_email@example.com\", page: 5, per_page:25) #  =\u003e Hash\n```\n\nBeyond 10,000 results it is strongly recommended to use the [data snapshot](https://docs.openalex.org/download-all-data/openalex-snapshot) instead of the API, but you can also use a cursor, which you can request with a *:\n```ruby\nSyconium.works(email: \"your_email@example.com\", per_page:1, cursor=\"*\") #  =\u003e Hash\n```\nThe metadata will contain the next_cursor to browse the next page:\n```ruby\nSyconium.works(email: \"your_email@example.com\", per_page:1, cursor=\"IlsxMDAuMCwgNTM2NCwgJ2h0dHBzOi8vb3BlbmFsZXgub3JnL1czMDEwNDQxNzMyJ10i\")\n```\n\n\n### Endpoints\n\nAll of the endpoints (authors, funders, keywords, institutions, publishers, sources, topics, works) are wrapped and function similarly.\n\n#### [Authors](https://docs.openalex.org/api-entities/authors)\n\nList authors:\n```ruby\nSyconium.authors() #  =\u003e Hash\n```\n\nSearch authors:\n```ruby\nSyconium.authors(email: \"your_email@example.com\", search: \"Smith\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.authors(email: \"your_email@example.com\", autocomplete: true, q: \"Smi\") #  =\u003e Hash\nSyconium.authors(email: \"your_email@example.com\", autocomplete: true, q: \"Smi\", search: \"John\") #  =\u003e Hash\n```\n\nFilter authors by [attributes](https://docs.openalex.org/api-entities/authors/filter-authors):\n```ruby\nSyconium.authors(email: \"your_email@example.com\", filter: 'has_orcid:true') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/authors/group-authors):\n```ruby\nSyconium.authors(email: \"your_email@example.com\", group_by: 'has_orcid') #  =\u003e Hash\n```\n\nGet an author by ID:\n```ruby\nSyconium.authors(email: \"your_email@example.com\", id: 'A1234567') #  =\u003e Hash\nSyconium.authors(email: \"your_email@example.com\", id: 'orcid:0000-0000-0000-0000') #  =\u003e Hash\n```\n\nGet a random author:\n```ruby\nSyconium.authors(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 authors:\n```ruby\nSyconium.authors(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n#### [Concepts](https://docs.openalex.org/api-entities/concepts)\nThe concepts endpoints should work, but they are depreciated/unmaintained so it is recommended to use Topics instead.\n\n\n#### [Funders](https://docs.openalex.org/api-entities/funders)\n\nList funders:\n```ruby\nSyconium.funders() #  =\u003e Hash\n```\n\nSearch funders:\n```ruby\nSyconium.funders(email: \"your_email@example.com\", search: \"Smith\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.funders(email: \"your_email@example.com\", autocomplete: true, q: \"Nationa\") #  =\u003e Hash\nSyconium.funders(email: \"your_email@example.com\", autocomplete: true, q: \"Nationa\", search: \"Biodiversity\") #  =\u003e Hash\n```\n\nFilter funders by [attributes](https://docs.openalex.org/api-entities/funders/filter-funders):\n```ruby\nSyconium.funders(email: \"your_email@example.com\", filter: 'country_code:ca') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/funders/group-funders):\n```ruby\nSyconium.funders(email: \"your_email@example.com\", group_by: 'country_code') #  =\u003e Hash\n```\n\nGet a funder by ID:\n```ruby\nSyconium.funders(email: \"your_email@example.com\", id: 'F4320306076') #  =\u003e Hash\nSyconium.funders(email: \"your_email@example.com\", id: 'ror:021nxhr62') #  =\u003e Hash\n```\n\nGet a random funders:\n```ruby\nSyconium.funders(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 funders:\n```ruby\nSyconium.funders(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n#### [Institutions](https://docs.openalex.org/api-entities/institutions)\n\nList institutions:\n```ruby\nSyconium.institutions() #  =\u003e Hash\n```\n\nSearch institutions:\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", autocomplete: true, q: \"biodiv\") #  =\u003e Hash\nSyconium.institutions(email: \"your_email@example.com\", autocomplete: true, q: \"greenhou\", search: \"frogs\") #  =\u003e Hash\n```\n\nFilter institutions by [attributes](https://docs.openalex.org/api-entities/institutions/filter-institutions):\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", filter: 'is_oa:true') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/institutions/group-institutions):\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", group_by: 'oa_status') #  =\u003e Hash\n```\n\nGet an institution by ID:\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", id: 'I157725225') #  =\u003e Hash\nSyconium.institutions(email: \"your_email@example.com\", id: 'ror:047426m28') #  =\u003e Hash\n```\n\nGet a random institution:\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 institutions:\n```ruby\nSyconium.institutions(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n#### [Keywords](https://docs.openalex.org/api-entities/keywords)\n\nList keywords:\n```ruby\nSyconium.keywords() #  =\u003e Hash\n```\n\nSearch keywords:\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", autocomplete: true, q: \"biodiv\") #  =\u003e Hash\nSyconium.keywords(email: \"your_email@example.com\", autocomplete: true, q: \"ani\", search: \"evolution\")) #  =\u003e Hash\n```\n\nFilter keywords by [attributes](https://docs.openalex.org/api-entities/keywords):\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", filter: 'works_count:1') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/keywords):\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", group_by: 'cited_by_count') #  =\u003e Hash\n```\n\nGet a keywords by ID:\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", id: 'biodiversity-conservation') #  =\u003e Hash\n```\n\nGet a random sample of 5 keywords:\n```ruby\nSyconium.keywords(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n#### [Publishers](https://docs.openalex.org/api-entities/publishers)\n\nList publishers:\n```ruby\nSyconium.publishers() #  =\u003e Hash\n```\n\nSearch publishers:\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", autocomplete: true, q: \"biodiv\") #  =\u003e Hash\nSyconium.publishers(email: \"your_email@example.com\", autocomplete: true, q: \"greenhou\", search: \"frogs\") #  =\u003e Hash\n```\n\nFilter publishers by [attributes](https://docs.openalex.org/api-entities/publishers/filter-publishers):\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", filter: 'hierarchy_level:0') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/publishers/group-publishers):\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", group_by: 'country_codes') #  =\u003e Hash\n```\n\nGet a publishers by ID:\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", id: 'P4310315930') #  =\u003e Hash\nSyconium.publishers(email: \"your_email@example.com\", id: 'ror:047426m28') #  =\u003e Hash\n```\n\nGet a random publishers:\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 publishers:\n```ruby\nSyconium.publishers(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n#### [Sources](https://docs.openalex.org/api-entities/sources)\nSources are where works are hosted and include several types: conferences, journals, preprint repositories, institutional repositories, etc.\n\nList sources:\n```ruby\nSyconium.sources() #  =\u003e Hash\n```\n\nSearch sources:\n```ruby\nSyconium.sources(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.sources(email: \"your_email@example.com\", autocomplete: true, q: \"eco\") #  =\u003e Hash\nSyconium.sources(email: \"your_email@example.com\", autocomplete: true, q: \"eco\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFilter sources by [attributes](https://docs.openalex.org/api-entities/sources/filter-sources):\n```sources\nSyconium.sources(email: \"your_email@example.com\", filter: 'is_oa:true') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/sources/group-sources):\n```ruby\nSyconium.sources(email: \"your_email@example.com\", group_by: 'oa_status') #  =\u003e Hash\n```\n\nGet a sources by ID:\n```ruby\nSyconium.sources(email: \"your_email@example.com\", id: 'S4306402618') #  =\u003e Hash\nSyconium.sources(email: \"your_email@example.com\", id: 'issn:1314-2828') #  =\u003e Hash\n```\n\nGet a random source:\n```ruby\nSyconium.sources(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 sources:\n```ruby\nSyconium.sources(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n#### [Topics](https://docs.openalex.org/api-entities/topics)\n\nList topics:\n```ruby\nSyconium.topics() #  =\u003e Hash\n```\n\nSearch topics:\n```ruby\nSyconium.topics(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.topics(email: \"your_email@example.com\", autocomplete: true, q: \"biodiv\") #  =\u003e Hash\nSyconium.topics(email: \"your_email@example.com\", autocomplete: true, q: \"greenhou\", search: \"frogs\") #  =\u003e Hash\n```\n\nFilter topics by [attributes](https://docs.openalex.org/api-entities/topics/filter-topics):\n```ruby\nSyconium.topics(email: \"your_email@example.com\", filter: 'subfield.id:1311') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/topics/group-topics):\n```ruby\nSyconium.topics(email: \"your_email@example.com\", group_by: 'subfield.id') #  =\u003e Hash\n```\n\nGet a topics by ID:\n```ruby\nSyconium.topics(email: \"your_email@example.com\", id: 'T10319') #  =\u003e Hash\n```\n\nGet a random topics:\n```ruby\nSyconium.topics(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 works:\n```ruby\nSyconium.topics(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n#### [Works](https://docs.openalex.org/api-entities/works)\n\nList works:\n```ruby\nSyconium.works() #  =\u003e Hash\n```\n\nSearch works:\n```ruby\nSyconium.works(email: \"your_email@example.com\", search: \"biodiversity\") #  =\u003e Hash\n```\n\nFor autocomplete, use the q parameter as the autocomplete field and also optionally you can use the filter and search parameters:\n```ruby\nSyconium.works(email: \"your_email@example.com\", autocomplete: true, q: \"biodiv\") #  =\u003e Hash\nSyconium.works(email: \"your_email@example.com\", autocomplete: true, q: \"greenhou\", search: \"frogs\") #  =\u003e Hash\n```\n\nFilter works by [attributes](https://docs.openalex.org/api-entities/works/filter-works):\n```ruby\nSyconium.works(email: \"your_email@example.com\", filter: 'is_oa:true') #  =\u003e Hash\n```\n\nGroup results by [attributes](https://docs.openalex.org/api-entities/works/group-works):\n```ruby\nSyconium.works(email: \"your_email@example.com\", group_by: 'oa_status') #  =\u003e Hash\n```\n\nGet a work by ID:\n```ruby\nSyconium.works(email: \"your_email@example.com\", id: 'pmid:33982150') #  =\u003e Hash\nSyconium.works(email: \"your_email@example.com\", id: 'doi:10.48550/arXiv.2205.01833') #  =\u003e Hash\nSyconium.works(email: \"your_email@example.com\", id: 'https://doi.org/10.48550/arXiv.2205.01833') #  =\u003e Hash\n```\n\nGet a random work:\n```ruby\nSyconium.works(email: \"your_email@example.com\", random: true) #  =\u003e Hash\n```\n\nGet a random sample of 25 works:\n```ruby\nSyconium.works(email: \"your_email@example.com\", sample: 25) #  =\u003e Hash\n```\n\n\n---\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update the `CHANGELOG.md`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/SpeciesFileGroup/syconium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SpeciesFileGroup/syconium/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT license](https://github.com/SpeciesFileGroup/syconium/blob/main/LICENSE.txt). You can learn more about the MIT license on [Wikipedia](https://en.wikipedia.org/wiki/MIT_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/mit/).\n\n## Code of Conduct\n\nEveryone interacting in the Syconium project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SpeciesFileGroup/syconium/blob/main/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeciesfilegroup%2Fsyconium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeciesfilegroup%2Fsyconium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeciesfilegroup%2Fsyconium/lists"}