{"id":20433846,"url":"https://github.com/flashbots/relay-specs","last_synced_at":"2026-03-09T13:06:40.186Z","repository":{"id":103821649,"uuid":"563456000","full_name":"flashbots/relay-specs","owner":"flashbots","description":"MEV-Boost Relay API Specs","archived":false,"fork":false,"pushed_at":"2025-12-23T14:59:11.000Z","size":5737,"stargazers_count":29,"open_issues_count":10,"forks_count":16,"subscribers_count":14,"default_branch":"main","last_synced_at":"2026-02-20T13:59:02.735Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://flashbots.github.io/relay-specs","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flashbots.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":"2022-11-08T16:44:57.000Z","updated_at":"2026-02-14T01:34:38.000Z","dependencies_parsed_at":"2024-04-27T04:20:01.183Z","dependency_job_id":"66a8baf7-3d01-4832-924a-d75803b0a96e","html_url":"https://github.com/flashbots/relay-specs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flashbots/relay-specs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Frelay-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Frelay-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Frelay-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Frelay-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flashbots","download_url":"https://codeload.github.com/flashbots/relay-specs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Frelay-specs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30297111,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T11:12:22.024Z","status":"ssl_error","status_checked_at":"2026-03-09T11:10:54.577Z","response_time":61,"last_error":"SSL_read: 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-15T08:21:46.482Z","updated_at":"2026-03-09T13:06:40.163Z","avatar_url":"https://github.com/flashbots.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ethereum Relay API Specifications\n\n![CI][ci]\n\nThe Relay API consists of two categories of APIs:\n\n* Builder API for builders to submit blocks.\n* Data API for anyone to query information about the relay.\n  * Things like registrations, bids, and payloads.\n\nFor interacting with validators, a relay should follow the [builder-specs][builder-specs].\n\nView the Relay API specifications here:\n* https://flashbots.github.io/relay-specs/\n\n## Contributing\n\nTo clone the repository:\n\n```\ngit submodule update --init --recursive\n```\n\nThe API specification is checked for lint errors before merging pull requests.\n\nTo run the linter locally, install it with:\n```console\nnpm install -g @stoplight/spectral-cli@6.2.1\n```\nand then run it:\n```console\nspectral lint relay-oapi.yaml\n```\n\n### Render API Specification\n\nTo render spec in browser, you will simply need an HTTP server to load the\n`index.html` file in root of the repo.\n\nFor example:\n```console\npython -m http.server 8080\n```\n\nThe spec will render at [http://localhost:8080](http://localhost:8080).\n\n### Usage\n\nLocal changes will be observable if \"dev\" is selected in the \"Select a\ndefinition\" drop-down in the web UI.\n\nIt may be necessary to tick the \"Disable Cache\" box in their browser's\ndeveloper tools to see changes after modifying the source.\n\n## Releasing\n\n1. Create and push tag:\n    - Ensure `info.version` in `relay-oapi.yaml` file is updated before tagging.\n    - CI will create a GitHub release and upload bundled spec file.\n2. Add release entrypoint in `index.html`\n\nIn `SwaggerUIBundle` configuration (inside `index.html` file), add another\nentry in `urls` field. Entry should be in following format (replace `\u003ctag\u003e`\nwith real tag name from step 1.):\n\n```javascript\n{url: \"https://github.com/flashbots/relay-specs/releases/download/\u003ctag\u003e/relay-oapi.yaml\", name: \"\u003ctag\u003e\"},\n```\n\n[builder-specs]: https://github.com/ethereum/builder-specs\n[ci]: https://github.com/flashbots/relay-specs/workflows/CI/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashbots%2Frelay-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflashbots%2Frelay-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashbots%2Frelay-specs/lists"}