{"id":18470061,"url":"https://github.com/greyhatguy007/persons-api","last_synced_at":"2026-03-19T04:35:09.975Z","repository":{"id":115578005,"uuid":"609953374","full_name":"greyhatguy007/persons-API","owner":"greyhatguy007","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-06T17:03:27.000Z","size":554,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-12T11:57:31.781Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greyhatguy007.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-03-05T18:13:55.000Z","updated_at":"2024-05-02T12:49:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"441a2627-1e01-474e-adcb-28b5d5218333","html_url":"https://github.com/greyhatguy007/persons-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/greyhatguy007/persons-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyhatguy007%2Fpersons-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyhatguy007%2Fpersons-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyhatguy007%2Fpersons-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyhatguy007%2Fpersons-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greyhatguy007","download_url":"https://codeload.github.com/greyhatguy007/persons-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyhatguy007%2Fpersons-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28691176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T11:01:27.039Z","status":"ssl_error","status_checked_at":"2026-01-23T11:00:26.909Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-06T10:12:51.725Z","updated_at":"2026-01-23T12:24:30.556Z","avatar_url":"https://github.com/greyhatguy007.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Persons-API\n\n\n**Note :** *The API is not yet hosted.*\n\n\u003cbr\u003e\n\n\u003cu\u003e\u003ch2\u003eUsage:\u003c/h2\u003e\u003c/u\u003e\n\n\u003cbr\u003e\n\n- Clone the repository\n\n    `git clone https://github.com/greyhatguy007/persons-API.git`\n\n- Install Node dependencies\n    \n    `npm install`\n\n- Modify the port Number in server.js if needed *( Default is 3000 )*\n\n    `const port = \u003cport number\u003e`\n\n- Set the verbose flag true in server.js if needed *(Default is false)*\n\n    `const verbose = true`\n\n- Run the start script\n\n    `npm run start`\n\n\n\u003chr\u003e\n\n\u003cu\u003e\u003ch2\u003eAPI Queries - Url\u003c/h2\u003e\u003c/u\u003e\n\n\u003cbr\u003e\n\n- To get all data\n    \n    - Method 1 : Use wildcard `*` in search query\n\n    - Method 2 : use the following route\n\n        `http://localhost:3000/api/`\n\n- To get a random data\n\n    `http://localhost:3000/api/random`\n\n- Query with search and maxValue\n\n    `http://localhost:3000/api/query?query=${QUERY}\u0026maxVal=${MAXVALUE}`\n    \n    Example:\n\n    `http://localhost:3000/api/query?query=john\u0026maxVal=50`\n\n- Get a data of particular id\n\n    `http://localhost:3000/api/id/${ID}`\n\n    Example:\n    \n    `http://localhost:3000/api/id/15325`\n\n\u003chr\u003e\n\n\u003cu\u003e\u003ch2\u003eUsage of api - An example\u003c/h2\u003e\u003c/u\u003e\n\n\u003cbr\u003e\n\n\nTo fetch a random data from terminal when deployed.\n```sh\ncurl http://localhost:3000/api/random\n```\n\u003cbr\u003e\n\nTo fetch a random data in a javascript file when deployed.\n```js\nconst http = require('http');\n\nconst url = \"http://localhost:3000/api/random\";\n\nhttp.get(url, (res) =\u003e {\n    res.on(\"data\", (data) =\u003e {\n        console.log(JSON.parse(data));\n    });\n}).on(\"error\", (err) =\u003e {\n    console.log(`Error\\n${err}`);\n});\n```\n\u003cbr\u003e\n\nOutput recieved\n```\n{\n    id: 16930,\n    fname: \"megan\",\n    lname: \"thoma\",\n    occupation: \"teacher\",\n    age: 24\n  }\n```\n\n\u003chr\u003e\n\n\u003cu\u003e\u003ch2\u003eWhen Deployed - UI\u003c/h2\u003e\u003c/u\u003e\n\n\u003cbr\u003e\n\n![ui-of-api](/public/imgs/ui.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreyhatguy007%2Fpersons-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreyhatguy007%2Fpersons-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreyhatguy007%2Fpersons-api/lists"}