{"id":18818443,"url":"https://github.com/smithsonian/smithsonian-openaccess","last_synced_at":"2025-09-18T16:41:03.195Z","repository":{"id":220181363,"uuid":"710358903","full_name":"Smithsonian/smithsonian-openaccess","owner":"Smithsonian","description":"Python module to query the Smithsonian Institution Open Access API","archived":false,"fork":false,"pushed_at":"2024-02-01T18:21:22.000Z","size":14,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-31T05:58:28.499Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/Smithsonian.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,"zenodo":null}},"created_at":"2023-10-26T14:35:38.000Z","updated_at":"2025-06-16T06:04:19.000Z","dependencies_parsed_at":"2025-08-08T18:31:18.067Z","dependency_job_id":null,"html_url":"https://github.com/Smithsonian/smithsonian-openaccess","commit_stats":null,"previous_names":["smithsonian/smithsonian-openaccess"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Smithsonian/smithsonian-openaccess","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smithsonian%2Fsmithsonian-openaccess","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smithsonian%2Fsmithsonian-openaccess/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smithsonian%2Fsmithsonian-openaccess/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smithsonian%2Fsmithsonian-openaccess/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Smithsonian","download_url":"https://codeload.github.com/Smithsonian/smithsonian-openaccess/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Smithsonian%2Fsmithsonian-openaccess/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275797723,"owners_count":25530253,"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-09-18T02:00:09.552Z","response_time":77,"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":[],"created_at":"2024-11-08T00:16:47.077Z","updated_at":"2025-09-18T16:41:03.166Z","avatar_url":"https://github.com/Smithsonian.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Smithsonian Open Access\n\nPython module to query the Smithsonian Institution Open Access API.\n\nA project of the Digitization Program Office, OCIO, Smithsonian.\n\nhttps://dpo.si.edu/\n\nFor details of the developer tools for the Open Access API: https://www.si.edu/openaccess/devtools\n\nFor details about Smithsonian Open Access: https://www.si.edu/openaccess\n\n## Installation\n\nTo install using pip:\n\n```bash\npip install si_openaccess\n```\n\nOr:\n\n```bash\npython3 -m pip install si_openaccess\n```\n\n## Requirements\n\n* The module requires Python 3.6 or higher.\n* The API requires you to provide your own 'api_key' value. Please register with https://api.data.gov/signup/ to get a key.\n\n## Usage\n\n### Load module \n\n```python\nfrom si_openaccess import si_openaccess\n```\n\n### Get Content\n\nTo fetch content based on id/url of an object ([docs](https://edan.si.edu/openaccess/apidocs/#api-content-content)):\n\n```python\nsi_openaccess.content(id=[ITEM ID], api_key=[YOUR API KEY])\n```\n\n### Fetch statistics\n\nTo fetch stats for CC0 objects/media ([docs](https://edan.si.edu/openaccess/apidocs/#api-metrics-stats)):\n\n```python\nsi_openaccess.metrics_stats(api_key=[YOUR API KEY])\n```\n\n### Search contents based on category\n\nTo fetch content based on a query against a category. art_design, history_culture or science_technology ([docs](https://edan.si.edu/openaccess/apidocs/#api-search-category_search)):\n\n```python\nsi_openaccess.category_search(q=[SEARCH TERMS], category=[CATEGORY], start=0, rows=10, sort=[SORT], api_key=[YOUR API KEY])\n```\n\nValues for `category` are:\n\n * `art_design`\n * `history_culture`\n * `science_technology`\n\nValues for `sort` are:\n\n * `relevancy`\n * `id`\n * `newest`\n * `updated`\n * `random`\n\n### Search\n\nTo fetch content based on a query ([docs](https://edan.si.edu/openaccess/apidocs/#api-search-search)):\n\n```python\nsi_openaccess.search(q=[SEARCH TERMS], start=0, rows=10, sort=[SORT], type=[TYPE], row_group=[ROW_GROUP], api_key=[YOUR API KEY])\n```\n\nValues for `sort` are:\n\n * `relevancy`\n * `id`\n * `newest`\n * `updated`\n * `random`\n\nValues for `type` are:\n\n * `edanmdm`\n * `ead_collection`\n * `ead_component` \n * `all`\n\nValues for `row_group` are:\n\n * `objects`\n * `archives`\n\n \n### Search Terms\n\nTo Fetches an array of terms based term category ([docs](https://edan.si.edu/openaccess/apidocs/#api-search-terms)):\n\n```python\nsi_openaccess.search_terms(category=[CATEGORY], starts_with=None, api_key=[YOUR API KEY])\n```\n\nValues for `category` are:\n\n * `culture`\n * `data_source`\n * `date`\n * `object_type`\n * `online_media_type`\n * `place`\n * `topic`\n * `unit_code`\n\nThe value for `starts_with` is optional.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmithsonian%2Fsmithsonian-openaccess","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmithsonian%2Fsmithsonian-openaccess","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmithsonian%2Fsmithsonian-openaccess/lists"}