{"id":42428403,"url":"https://github.com/jnstockley/api","last_synced_at":"2026-05-12T03:08:58.959Z","repository":{"id":221633997,"uuid":"754944921","full_name":"jnstockley/api","owner":"jnstockley","description":"Custom API written in Python using FastAPI","archived":false,"fork":false,"pushed_at":"2026-04-30T01:56:49.000Z","size":2021,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-30T02:27:01.327Z","etag":null,"topics":["api","docker","fastapi","python","rest"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jnstockley.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-09T04:39:32.000Z","updated_at":"2026-04-30T00:18:35.000Z","dependencies_parsed_at":"2024-02-19T03:26:26.108Z","dependency_job_id":"beb836e1-5202-4194-8884-405ac180bbdc","html_url":"https://github.com/jnstockley/api","commit_stats":null,"previous_names":["jnstockley/api"],"tags_count":142,"template":false,"template_full_name":null,"purl":"pkg:github/jnstockley/api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jnstockley%2Fapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jnstockley%2Fapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jnstockley%2Fapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jnstockley%2Fapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jnstockley","download_url":"https://codeload.github.com/jnstockley/api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jnstockley%2Fapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32921658,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-11T17:09:15.040Z","status":"online","status_checked_at":"2026-05-12T02:00:06.338Z","response_time":102,"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":["api","docker","fastapi","python","rest"],"created_at":"2026-01-28T03:34:22.161Z","updated_at":"2026-05-12T03:08:58.939Z","avatar_url":"https://github.com/jnstockley.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API\nThis is a custom API, written in Python using FastAPI, to help me accomplish tasks the can be improved through a RESTful API\n\n## Setup\nSimplest setup is to start from [compose.yml](https://github.com/jnstockley/api/blob/dev/compose.yml) and [template.env](https://github.com/jnstockley/api/blob/dev/template.env), which should be renamed to `.env`\n\n### Environment Vairables\n- `API_KEY` - Any long, random string. Keep this secret as this is the only form of authentication for the API. All routes require it, except `/health-check/`\n- `DATABASE_URL` - The URL to connect to postgres DB. Must start with `postgresql+psycopg://`. Should be in the format specifiec in [template.env](https://github.com/jnstockley/api/blob/dev/template.env)\n- `TZ` - Timezone of the container\n- `PGTZ` - Timezone the Postgres container should use\n\n## How to Access\nUsing the [compose.yml](https://github.com/jnstockley/api/blob/dev/compose.yml) file, you can access the API at `http://\u003cIP\u003e:5000/health-check`. If everything is setup correctly, you should see `{\"status\":\"ok\"}`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjnstockley%2Fapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjnstockley%2Fapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjnstockley%2Fapi/lists"}