{"id":27861254,"url":"https://github.com/reservoirprotocol/marketplace-v1","last_synced_at":"2025-05-04T18:35:51.342Z","repository":{"id":37007252,"uuid":"448930045","full_name":"reservoirprotocol/marketplace-v1","owner":"reservoirprotocol","description":"An open source NFT marketplace built on Reservoir.","archived":false,"fork":false,"pushed_at":"2023-05-25T22:47:20.000Z","size":24374,"stargazers_count":171,"open_issues_count":4,"forks_count":259,"subscribers_count":6,"default_branch":"main","last_synced_at":"2023-11-07T19:24:24.852Z","etag":null,"topics":["api","deprecated","ethereum","nft","obselete","sdk"],"latest_commit_sha":null,"homepage":"https://www.reservoir.market","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reservoirprotocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-17T14:37:52.000Z","updated_at":"2023-10-17T20:27:01.000Z","dependencies_parsed_at":"2023-02-10T23:31:06.310Z","dependency_job_id":null,"html_url":"https://github.com/reservoirprotocol/marketplace-v1","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reservoirprotocol%2Fmarketplace-v1","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reservoirprotocol%2Fmarketplace-v1/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reservoirprotocol%2Fmarketplace-v1/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reservoirprotocol%2Fmarketplace-v1/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reservoirprotocol","download_url":"https://codeload.github.com/reservoirprotocol/marketplace-v1/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252383320,"owners_count":21739308,"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":["api","deprecated","ethereum","nft","obselete","sdk"],"created_at":"2025-05-04T18:35:50.542Z","updated_at":"2025-05-04T18:35:51.311Z","avatar_url":"https://github.com/reservoirprotocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003eReservoir Market v1 - [⛔️ DEPRECATED]\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e\nAn open source NFT marketplace built on Reservoir.\n\nLearn more about [v2 of the Reservoir Market](https://github.com/reservoirprotocol/marketplace-v2).\n\n[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n\nReservoir Market is an open source marketplace that enables communities to easily launch their own NFT marketplace, accessing instant liquidity aggregated from other major marketplaces.\n\nThe marketplace supports 3 different modes:\n\n-  Single collection (e.g.  [Crypto Coven](https://cryptocoven.reservoir.market/))\n-  Multi collection community (e.g.  [BAYC](https://bayc.reservoir.market/))\n-  All collections ([example](https://www.reservoir.market/))\n  \nWith each deployment, communities are given full control over their marketplace from designing their look and feel to setting their own marketplace fees.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started (Self-Hosted)\n\n### Prerequisites\n1. Install [Node.js and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)\n2. Install [Yarn](https://classic.yarnpkg.com/en/docs/install)\n3. Request free [Reservoir API key](https://api.reservoir.tools/#/0.%20Auth/postApikeys)\n\n### Built With\n\n* [ReservoirKit](https://docs.reservoir.tools/docs/reservoir-kit)\n* [Reservoir Protocol and API](https://reservoirprotocol.github.io/)\n* [Next.js](https://nextjs.org/)\n* [React.js](https://reactjs.org/)\n* [Ethers.io](https://ethers.io/)\n* [WAGMI](https://wagmi.sh/)\n* [Tailwind CSS](https://tailwindcss.com/)\n\n### Installation\n\nFork this repo and follow these instructions to install dependancies.\n\nWith yarn:\n\n```bash\n$ yarn install\n```\n\nWith NPM:\n\n```bash\n$ npm install\n```\n\n### Configuration\nReservoir Market is built to be fully configurable using environment variables. To preview your configuration locally you can copy the values you want to use from  `env.development`  or  `env.production`  into a new file called  `.env.local`.\n\nNote: Environment variables can also be added during deployment via deployment platforms like [vercel](https://vercel.com/).\n\n**Required Configuration**\n| Environment Variable           | Required | Description                                                                         | Example              |\n|--------------------------------|----------|-------------------------------------------------------------------------------------|---------------------|\n| NEXT_PUBLIC_RESERVOIR_API_BASE | `true`   | The Reservoir API base URL. Available on Mainnet, Rinkeby, Goerli, and Optimism.                       | https://api-rinkeby.reservoir.tools/ https://api.reservoir.tools/ |\n| NEXT_PUBLIC_CHAIN_ID           | `true`   | The Ethereum network to be used. 1 for Etherem Mainnet and 4 for Rinkeby Testnet, etc.   | 1 4                                                               |\n| NEXT_PUBLIC_PROXY_API_BASE     | `true`   | The proxy API used to pass the Reservoir API key without exposing it to the client. | /api/reservoir                                                    |\n| NEXT_PUBLIC_RESERVOIR_API_KEY              | `true`   | Reservoir API key provided by the Reservoir Protocol. [Get your own API key](https://api.reservoir.tools/#/0.%20Auth/postApikeys).         | 123e4567-e89b-12d3-a456-426614174000                              |\n| NEXT_PUBLIC_ALCHEMY_ID              | `true`   | Alchemy API key required for buying items on mobile. [Get your own API key here](https://docs.alchemy.com/alchemy/introduction/getting-started#1.create-an-alchemy-key).         | 123e4567-e89b-12d3-a456-426614174000   \n\n**General Configuration**\n| Environment Variable                | Required | Description                                                                                                                                          | Example                                                                                                                                                                                   |\n| :---------------------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| NEXT_PUBLIC_SOURCE_ID               | `false`   | **DEPRECATED**: The source ID used to attribute listings and offers from your marketplace.                                                           | Reservoir Market                                                                                                                                                                          |\n| NEXT_PUBLIC_SOURCE_DOMAIN           | `false`   | The source ID used to attribute listings and offers from your marketplace. Must be in a domain format.                                               | reservoir.market                                                                                                                                                                          |\n| NEXT_PUBLIC_SOURCE_NAME             | `false`  | The source name used to attribute listings and offers from your marketplace, falls back to the domain.                                               | Reservoir Market                                                                                                                                                                          |\n| NEXT_PUBLIC_ORDER_KIND              | `false`  | The order kind to be used when listing or making offers on your marketplace. Default will use `seaport` if not set.                                  | zeroex-v4. wyvern-v2.3, seaport                                                                                                                                                           |\n| NEXT_PUBLIC_FEE_BPS                 | `false`  | The marketplace fee that will be earned from native listings and offers on your marketplace. Configured as \u003c\u003cglossary:bps\u003e\u003e.                         | 100                                                                                                                                                                                       |\n| NEXT_PUBLIC_FEE_RECIPIENT           | `false`  | The address that will receive marketplace fee.                                                                                                       | 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00                                                                                                                                                |\n| NEXT_PUBLIC_COLLECTION              | `false`  | Use this to configure a single collection marketplace or set the default collection for your community marketplace.                                  | 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63                                                                                                                                                |\n| NEXT_PUBLIC_COLLECTION_SET_ID       | `false`  | Use this to configure a community marketplace. [Generate your collection set ID here](https://docs.reservoir.tools/reference/postcollectionssetsv1). | f566ba09c14f56aedeed3f77e3ae7f5ff28b9177714d3827a87b7a182f8f90ff                                                                                                                          |\n| NEXT_PUBLIC_COMMUNITY               | `false`  | Use this to configure a community marketplace. Note: Community IDs are only available for certain communities.                                       | artblocks                                                                                                                                                                                 |\n| NEXT_PUBLIC_REDIRECT_HOMEPAGE       | `false`  | If enabled, homepage will automatically redirect to collection page set in NEXT_PUBLIC_COLLECTION.                                                   | true                                                                                                                                                                                      |\n| NEXT_PUBLIC_EXTERNAL_LINKS          | `false`  | External links to be displayed in the top navigation bar.                                                                                            | Blog::[\\\u003c\\\u003c\\\u003c\\\u003chttps://blog.com,Docs::https://docs.com\u003e\u003e\u003e\u003e](https://blog.com,Docs::https://docs.com)                                                                                      |\n| NEXT_PUBLIC_COLLECTION_DESCRIPTIONS | `false`  | Customize descriptions on a per collection basis.                                                                                                    | 0xb74bf94049d2c01f8805b8b15db0909168cabf46::`test description`,0xc751c84678d8e229e361f9b04c080256516f4a0a::`another description`                                                          |\n| NEXT_PUBLIC_NAVBAR_LOGO_LINK        | `false`  | Customize the marketplace navbar logo's link.                                                                                                        | \u003chttps://blog.com\u003e                                                                                                                                                                        |\n| NEXT_PUBLIC_DEFAULT_TO_SEARCH       | `false`  | If enabled, search bar will be displayed instead of collection switcher.                                                                             | true                                                                                                                                                                                      |\n| NEXT_PUBLIC_LISTING_CURRENCIES      | `false`  | Customize which currency users can list in.                                                                                                          | [{\"symbol\": \"ETH\", \"decimals\": 18, \"contract\": \"0x0000000000000000000000000000000000000000\"},{\"symbol\": \"USDC\", \"decimals\": 6, \"contract\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\"}] |\n\n**Design Configuration**\n\n| Environment Variable                     | Required | Description                                                                                                                                                   | Example                                                                                                                                                                                            |\n| :--------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| NEXT_PUBLIC_NAVBAR_LOGO                  | `false`  | The logo of your marketplace that appears on mobile.                                                                                                          | \u003chttps://www.reservoir.market/reservoir.svg\u003e                                                                                                                                                       |\n| NEXT_PUBLIC_DESKTOP_NAVBAR_LOGO          | `false`  | The logo of your marketplace that appears on desktop.                                                                                                         | \u003chttps://www.reservoir.market/reservoir-desktop.svg\u003e                                                                                                                                               |\n| NEXT_PUBLIC_FAVICON                      | `false`  | The favicon for your marketplace.                                                                                                                             | \u003chttps://www.reservoir.market/reservoir.svg\u003e                                                                                                                                                       |\n| NEXT_PUBLIC_SOURCE_ICON                  | `false`  | The icon that appears on native listings.                                                                                                                     | \u003chttps://www.reservoir.market/reservoir.svg\u003e                                                                                                                                                       |\n| NEXT_PUBLIC_DISABLE_POWERED_BY_RESERVOIR | `false`  | Use this to disable the Powered by Reservoir tag on modals.                                                                                                   | true                                                                                                                                                                                               |\n| NEXT_PUBLIC_DARK_MODE                    | `false`  | Use this to enable dark mode theme.                                                                                                                           | true                                                                                                                                                                                               |\n| NEXT_PUBLIC_THEME_SWITCHING_ENABLED      | `false`  | Use this to allow users to toggle between the dark and light theme. If NEXT_PUBLIC_DARK_MODE is enabled then that will be the default theme selected.         | true                                                                                                                                                                                               |\n| NEXT_PUBLIC_PRIMARY_COLOR                | `false`  | Use this to select your primary color.                                                                                                                        | default, red, orange, lime, green, blue                                                                                                                                                            |\n| NEXT_PUBLIC_FONT_FAMILY                  | `false`  | Primary sans font used in your marketplace.                                                                                                                   | Inter, Montserrat, Open Sans, Playfair Display, Roboto, Druk, Nunito Sans, Lucida Grande, Gazpacho, Frank Ruh Libre, Chalkboard, Gothicus Roman, Styrene B Black, Montserrat Uppercase Bold Italic |\n| NEXT_PUBLIC_BODY_FONT_FAMILY             | `false`  | Secondary font family used in your marketplace.                                                                                                               | Inter, Montserrat, Open Sans, Playfair Display, Roboto, Druk, Nunito Sans, Lucida Grande, Gazpacho, Frank Ruh Libre, Chalkboard, Gothicus Roman, Styrene B Black, Montserrat Uppercase Bold Italic |\n| NEXT_PUBLIC_FONT_URLS                    | `false`  | Use in conjunction with NEXT_PUBLIC_FONT_FAMILY and NEXT_PUBLIC_BODY_FONT_FAMILY to pull in a remote font, using services like google fonts, adobe fonts etc. | \u003chttps://fonts.googleapis.com/css2?family=Blaka\u0026display=swap,https://fonts.googleapis.com/css2?family=Bebas+Neue\u0026display=swap\u003e                                                                     |\n| NEXT_PUBLIC_BANNER_IMAGE                 | `false`  | The background banner image used on collection pages. If not set this will use the default collection banner.                                                 | \u003chttps://www.reservoir.market/banner.png\u003e                                                                                                                                                          |\n| NEXT_PUBLIC_DISABLE_COLLECTION_BG        | `false`  | Use this to hide the background banners on collection pages.                                                                                                  | true                                                                                                                                                                                               |\n| NEXT_PUBLIC_TAGLINE                      | `false`  | A tagline to be displayed in the homepage. Only available if NEXT_PUBLIC_COLLECTION and NEXT_PUBLIC_COMMUNITY are unset.                                      | Buy, sell and collect NFTs!                                                                                                                                                                        |\n| NEXT_PUBLIC_FOOTER_ENABLED               | `false`  | If enabled, a footer will be displayed on the homepage and the list of trending collections will be capped at 100.                                            | true                                                                                                                                                                                               |\n\n**SEO Configuration**\n\n| Environment Variable         | Required | Description                            | Example                                                                  |\n| :--------------------------- | :------- | :------------------------------------- | :----------------------------------------------------------------------- |\n| NEXT_PUBLIC_META_TITLE       | `false`  | The text used in the \u003ctitle\u003e tag.      | Reservoir Market \\| Open Source NFT Marketplace                          |\n| NEXT_PUBLIC_META_DESCRIPTION | `false`  | The text used in the meta description  | Reservoir Market is an open source NFT marketplace built with Reservoir. |\n| NEXT_PUBLIC_META_OG_IMAGE    | `false`  | The image used in the meta og images . | \u003chttps://www.reservoir.market/og.png\u003e                                    |\n\n### Run the App\n\nOnce you have your setup ready, run:\n\nWith yarn:\n\n    $ yarn dev\n\nWith npm:\n\n    $ npm run dev\n\n### Deploy with Vercel\n\nThis is a Next.js app that can be easily deployed using  [Vercel](https://vercel.com/). For  more information on how to deploy your Github repository with Vercel visit their [docs](https://vercel.com/docs/concepts/projects/overview).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- Contributing --\u003e\n## Contributing\n\nIf you'd like to contribute please follow the [guidelines](https://github.com/reservoirprotocol/marketplace/blob/main/CONTRIBUTING.md).\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nTwitter: [@reservoir0x](https://twitter.com/reservoir0x)\nProject Link: [Reservoir](https://reservoirprotocol.github.io/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freservoirprotocol%2Fmarketplace-v1","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freservoirprotocol%2Fmarketplace-v1","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freservoirprotocol%2Fmarketplace-v1/lists"}