{"id":21658920,"url":"https://github.com/3box/3box-graphql","last_synced_at":"2025-07-17T21:31:58.010Z","repository":{"id":48060696,"uuid":"161105074","full_name":"3box/3box-graphql","owner":"3box","description":"3box GraphQL Service ","archived":true,"fork":false,"pushed_at":"2021-08-09T12:15:08.000Z","size":1402,"stargazers_count":9,"open_issues_count":23,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2023-04-03T13:52:59.470Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3box.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}},"created_at":"2018-12-10T02:28:57.000Z","updated_at":"2023-01-28T07:20:37.000Z","dependencies_parsed_at":"2022-08-12T17:40:55.373Z","dependency_job_id":null,"html_url":"https://github.com/3box/3box-graphql","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3box%2F3box-graphql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3box%2F3box-graphql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3box%2F3box-graphql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3box%2F3box-graphql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3box","download_url":"https://codeload.github.com/3box/3box-graphql/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226305062,"owners_count":17603732,"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","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-25T09:30:03.094Z","updated_at":"2024-11-25T09:30:23.749Z","avatar_url":"https://github.com/3box.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# ⚠️ ⚠️ Deprecated in favor of Ceramic ⚠️ ⚠️ \n\u003e 3box.js and related tools built by 3Box Labs are deprecated and no loger supported. Developers are encurraged to build with https://ceramic.network which is a more secure and decentralized protocol for sovereign data.\n\n [Endpoint](#endpoint) | [Requests](#requests) | [Schema](#schema) | [Running \u0026 Deployment](#run)\n\n# 3Box GraphQL\n\nA 3Box GraphQL service. Run against our [profile caching service and pinning node](https://github.com/3box/3box-pinning-server) to offer an easy to use query language for Ethereum profiles. This service is configured as an AWS Lambda function.\n\n## \u003ca name=\"endpoint\"\u003e\u003c/a\u003eEndpoint\n\nThe 3BoxGraphQL service run by 3Box is available at the following endpoint.\n\n```\nhttps://api.3box.io/graph\n```\n\n## \u003ca name=\"requests\"\u003e\u003c/a\u003e Requests\n\nRequest:\n\n```bash\ncurl \\\n  -X POST \\\n  -H \"Content-Type: application/json\" \\\n  --data '{ \"query\": \"{ profile(id: \\\"0xe3b281f3dd2b87c7b3eacc0402a4fd7d827f2956\\\") { name } }\" }' \\\n  https://api.3box.io/graph\n```\nResponse (body):\n\n```\n{\"data\":{\"profile\":{\"name\":\"Zach\"}}}\n```\n\n## \u003ca name=\"schema\"\u003e\u003c/a\u003e Schema\n\nA Profile schema is defined along with queries for both a profile and list of profiles. This schema is evolving and intended to remain minimal for now. Profiles are not necessarily strictly defined, as users and apps can add any fields of interest. This schema represents a minimally shared set of common fields you are likely to find available. Fields not available will return null if requested.\n\nProfile Object:\n\n```\ntype Profile {\n  name: String\n  image: String\n  emoji: String\n  description: String\n  eth_address: String\n  did: String\n  location: String\n  website: String\n  proof_github: String\n  proof_twitter: String\n  proof_did: String\n  proof_eth_address: String\n}\n```\n\nQueries for a profile of profiles list by profile id (ethereum address):\n\n```\ntype Query {\n  profiles(ids: [String]!): [Profile]\n  profile(id: String!): Profile\n}\n```\n\n## \u003ca name=\"run\"\u003e\u003c/a\u003e Running and Deployment\n\nYou can run and deploy this service with [serverless](https://www.npmjs.com/package/serverless).\n\nTo run locally:\n\n```bash\n$ serverless offline start\n```\n\nTo deploy: (must also have AWS keys configured)\n```bash\n$ serverless deploy\n```\n\n## Maintainers\n[@zachferland](https://github.com/zachferland)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3box%2F3box-graphql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3box%2F3box-graphql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3box%2F3box-graphql/lists"}