Complete OpenSea API v2 developer hub featuring Markdown references for all REST endpoints, Model Context Protocol (MCP) server setup, OpenSea CLI, and modular Agent Skills. Connect your AI coding assistants (Claude, Cursor, VS Code) to OpenSea natively through natural language prompts.
OpenSea API & AI Agent Integration Hub
Welcome to the OpenSea API & AI Agent Integration Hub! This repository is a comprehensive, production-ready developer resource containing full REST API specifications, developer tools, and state-of-the-art AI Agent integration configurations (MCP & Agent Skills) for interacting with OpenSea.
Whether you are building standard web3 web apps, scripting bulk NFT actions, or developing advanced AI agents that can buy, swap, mint, and analyze NFTs through natural language, this repository has everything you need.
🚀 Key Features
- 🤖 Model Context Protocol (MCP) Support: Full setup guide and schema details to connect OpenSea as a hosted tool server to Claude Desktop, Cursor, VS Code, ChatGPT, and custom LLM applications.
- 📦 Agent Skills: Plug-and-play knowledge packages and tools for AI coding assistants (like Cursor, Claude Code, and Windsurf).
- 💻 Developer Tooling: Native integrations for the
opensea-cli,opensea-jsSDK, andstream-jsfor real-time WebSocket event feeds. - 📈 Comprehensive Endpoint Reference: 80+ structural Markdown pages documenting every NFT endpoint, Seaport trade, contract deployment, token swap, profile lookup, and minting operation on OpenSea.
📂 Repository Directory Structure
The repository is structured to make documentation easily readable by both human developers and LLM-based coding agents:
├── README.md # Main repository guide
├── LICENSE # MIT License
├── mcp.md # Model Context Protocol (MCP) integration guide
├── agent-skill.md # AI Agent Skill installation and usage guide
├── api-overview.md # Core REST API introduction
├── opensea-cli.md # CLI usage and authentication
├── opensea-js.md # Javascript/Typescript SDK setup
├── stream-js.md # WebSocket Stream API integration
├── api-keys.md # Free-tier and custom API Key guidelines
└── [endpoints].md # Individual markdown files for all API endpoints:
# - get_nft.md, get_collection.md, get_portfolio_stats.md
# - build_offer_v2.md, post_listing.md, sweep_collection.md
# - deploy_drop_contract.md, post_swap_execute.md
🛠️ Getting Started
1. Retrieve an API Key
Your API key allows you to access both the REST and Stream APIs. You can obtain a free-tier key instantly with a simple curl request (perfect for quick prototypes and agents):
curl -X POST https://api.opensea.io/api/v2/auth/keys
For higher rate limits, sign in to OpenSea, navigate to Settings → Developer, and request a full production key.
2. Connect OpenSea to your AI Coding Assistant (MCP)
Add OpenSea as an MCP server to your AI tool configuration (such as Cursor or Claude Desktop) using Streamable HTTP (recommended):
- URL:
https://mcp.opensea.io/mcp - JSON Config:
{ "mcpServers": { "OpenSea": { "url": "https://mcp.opensea.io/mcp", "headers": { "X-API-KEY": "YOUR_API_KEY" } } } }
Once configured, you can prompt your assistant:
"What is the floor price of Bored Ape Yacht Club?" "Swap 0.05 ETH to USDC on Base" "Show me trending tokens on Solana"
3. Install via Agent Skills
If you are using tools supporting modular skills:
npx skills add ProjectOpenSea/opensea-skill
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🤝 Contributing
Contributions are welcome! If you find a typo, outdated endpoint parameter, or want to add custom helper scripts:
- Fork this repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.