{"id":19685666,"url":"https://github.com/CheckerNetwork/voyager-api","last_synced_at":"2025-09-16T23:31:51.363Z","repository":{"id":226029829,"uuid":"767524193","full_name":"CheckerNetwork/voyager-api","owner":"CheckerNetwork","description":"🪐 Voyager API","archived":true,"fork":false,"pushed_at":"2024-06-05T07:44:09.000Z","size":1842,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T12:36:29.390Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CheckerNetwork.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":"2024-03-05T12:59:11.000Z","updated_at":"2024-06-05T08:23:45.000Z","dependencies_parsed_at":"2025-01-29T12:47:50.628Z","dependency_job_id":null,"html_url":"https://github.com/CheckerNetwork/voyager-api","commit_stats":null,"previous_names":["filecoin-station/voyager-api","checkernetwork/voyager-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CheckerNetwork/voyager-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fvoyager-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fvoyager-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fvoyager-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fvoyager-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CheckerNetwork","download_url":"https://codeload.github.com/CheckerNetwork/voyager-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckerNetwork%2Fvoyager-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275504538,"owners_count":25476874,"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-16T02:00:10.229Z","response_time":65,"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-11T18:23:08.923Z","updated_at":"2025-09-16T23:31:50.835Z","avatar_url":"https://github.com/CheckerNetwork.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# voyager-api\n[Voyager](https://github.com/filecoin-station/voyager) API\n\n[![CI](https://github.com/filecoin-station/voyager-api/actions/workflows/ci.yml/badge.svg)](https://github.com/filecoin-station/voyager-api/actions/workflows/ci.yml)\n\n## Routes\n\n### `POST /retrievals`\n\nStart a new retrieval.\n\nBody:\n\n```typescript\n{\n  zinniaVersion: String\n}\n\nResponse:\n\n```typescript\n{\n  id: String,\n  cid: String\n}\n```\n\n### `PATCH /retrievals/:id`\n\nParameters:\n- `id`: Request ID (from `POST /retrievals`)\n\nBody:\n\n```typescript\n{\n  participantAddress: String,\n  carTooLarge: Boolean,\n  statusCode: Number,\n  endAt: String          // ISO 8601\n}\n```\n\nDates should be formatted as [ISO 8601](https://tc39.es/ecma262/#sec-date-time-string-format)\nstrings.\n\nResponse:\n\n```\nOK\n```\n\n## Development\n\n### Database\n\nSet up [PostgreSQL](https://www.postgresql.org/) with default settings:\n - Port: 5432\n - User: _your system user name_\n - Password: _blank_\n - Database: _your system user name_\n\nAlternatively, set the environment variable `$DATABASE_URL` with `postgres://${USER}:${PASS}@${HOST}:${POST}/${DATABASE}`.\n\nThe Postgres user and database need to already exist, and the user\nneeds full management permissions for the database.\n\nYou can also the following command to set up the PostgreSQL server via Docker:\n\n```bash\ndocker run -d --name voyager-db \\\n  -e POSTGRES_HOST_AUTH_METHOD=trust \\\n  -e POSTGRES_USER=$USER \\\n  -e POSTGRES_DB=$USER \\\n  -p 5432:5432 \\\n  postgres\n```\n\n### `voyager-api`\n\nStart the API service:\n\n```bash\nnpm start\n```\n\nRun tests and linters:\n\n```bash\nnpm test\n```\n\n## Deployment\n\nPushes to `main` will be deployed automatically.\n\nPerform manual devops using [Fly.io](https://fly.io):\n\n```bash\n$ fly deploy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCheckerNetwork%2Fvoyager-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCheckerNetwork%2Fvoyager-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCheckerNetwork%2Fvoyager-api/lists"}