O que é a OpenSea API?

Introdução a NFTs

NFTs, ou tokens não-fungíveis, são itens digitais na blockchain que são comprovadamente únicos. Desde sua concepção, essa classe de ativos cresceu para incluir colecionáveis em formatos de imagem, vídeo e áudio, itens de jogos, arte digital, ingressos para eventos, nomes de domínio e até registros de propriedade para ativos físicos. E os casos de uso continuam a crescer.

Geralmente associados à blockchain Ethereum, os NFTs se baseiam nos padrões de token ERC-721 e ERC-1155, e, se você constrói sobre o segundo, permitem semi-fungibilidade — a capacidade de criar tokens que são intercambiáveis/fungíveis quando cunhados, mas se tornam não intercambiáveis/não-fungíveis após o resgate. Alguns exemplos de tokens semi-fungíveis incluem ingressos para shows, vales-presente e cupons. Recentemente, também tem havido discussão sobre NFTs "soulbound", que seriam não transferíveis após a aquisição, permitindo que indivíduos verifiquem sua identidade, confirmem presença em eventos e detenham direitos de governança distribuídos e baseados em participação em organizações descentralizadas (DAOs). Soulbound NFTs serviriam para expandir o espaço de NFTs além dos sinalizadores sociais e incentivos financeiros que atualmente dominam o espaço em decorrência da capacidade de negociar esses ativos em mercados secundários.

Enquanto isso, à medida que o mercado de compra e venda de NFTs continua a crescer e se tornar uma parte desproporcionalmente grande do espaço Web3, com mais de US$ 41 bilhões em volume de negociação até o final de 2021, desenvolvedores estão migrando para esse espaço para construir sobre essa classe de ativos única.

NFTs oferecem uma oportunidade única tanto para desenvolvedores de aplicações quanto para desenvolvedores de smart contracts. Independentemente de os projetos que você está construindo exigirem interface direta com a blockchain, um requisito importante é ter acesso a um índice do ecossistema de NFT, com informações detalhadas sobre propriedade, coleções e eventos. Para desenvolvedores de smart contracts, é igualmente valiosa a capacidade de construir marketplaces de NFT nativos por meio de funcionalidades que permitem a compra e venda de NFTs.

OpenSea, o principal marketplace peer-to-peer para NFTs e outros ativos digitais, atende a esses requisitos essenciais dos desenvolvedores por meio de sua API e SDK, um conjunto de ferramentas simples de integrar e usar que já serve de base para a maioria dos apps convencionais que lidam com NFTs hoje. Mas uma parcela tão grande do mercado depender de um sistema tão centralizado não é isento de problemas, especialmente porque a plataforma da OpenSea enfrentou recentemente problemas de confiabilidade, e existem diversas alternativas viáveis à API da OpenSea.

O que é a OpenSea?

A OpenSea funciona como um marketplace horizontal e peer-to-peer para bens digitais, permitindo que usuários comprem, vendam e leiloem NFTs, itens digitais raros e colecionáveis cripto. Para desenvolvedores, a OpenSea oferece integrações e ferramentas extensas para apps no espaço de NFT. Eles indexam e fornecem o maior conjunto de dados de NFTs (existindo desde que os primeiros projetos foram listados), e atuam como um mercado secundário para coleções e projetos populares. ‍ A OpenSea suporta diversos tokens e chains amplamente utilizados, e estão ativamente expandindo essa lista. Eles suportam tanto os não-fungíveis ERC-721 quanto os semi-fungíveis ERC-1155, e são uma plataforma multi-chain, oferecendo ferramentas para Polygon e Klaytn além de Ethereum. ‍ Junto ao seu marketplace, a plataforma de API da OpenSea alimenta ferramentas de terceiros, com sua REST API servindo de base para diversos projetos importantes na comunidade Web3, como MetaMask, Coinbase Wallet e Rainbow, entre outros.

A plataforma de desenvolvimento da OpenSea

As ferramentas de desenvolvimento da OpenSea consistem em uma REST API que permite aos desenvolvedores acessar e exibir metadados sobre NFTs, e um Software Development Kit (SDK) que se baseia na API para permitir o desenvolvimento com interface direta com a blockchain, como para a criação de marketplaces de NFT via compra e venda de ativos digitais. A plataforma de desenvolvimento da OpenSea oferece diversos diferenciais importantes.

Para o desenvolvimento de aplicações via API:

1. Processo simples para exibir NFTs e coleções no frontend.
2. Acesso a metadados sobre transações, propriedade e outros detalhes de cada ativo e coleção no banco de dados da OpenSea.
3. A capacidade de monitorar a carteira de qualquer usuário quanto a transações de NFT, e recuperar informações sobre os ativos de qualquer usuário.
4. Ferramentas robustas de gerenciamento de dados, incluindo filtragem e estatísticas por categoria.
5. A OpenSea fornece documentação abrangente que facilita o início do uso da API.

E para interação com smart contracts via SDK:

1. Acesso à maior comunidade do espaço para colecionadores e vendedores por meio do contrato de exchange da OpenSea.
2. A capacidade de construir funcionalidades de e-commerce que leem e escrevem na blockchain sem a necessidade de implantar seus próprios contratos.
3. Construir marketplaces nativos para compra e venda de NFTs com uma ampla gama de recursos e estruturas de pagamento.
4. A OpenSea oferece suporte integrado a royalties por meio do Royalty Registry, padronizado entre plataformas.
5. A documentação do SDK da OpenSea é atualizada regularmente para conformidade com os padrões Solidity mais recentes.

1. Ferramentas de API

A API da OpenSea fornece endpoints para os seguintes modelos indexados na plataforma OpenSea: assets (tokens individuais ERC-721/ERC-1155), coleções de NFT, eventos, orders, accounts e asset contracts. Como parte da funcionalidade do SDK, a orders API permite recuperação (GET) e envio (POST) de orders de NFT. A OpenSea oferece acesso às APIs de Mainnet e Testnet (via a rede Ethereum Rinkeby), para que desenvolvedores possam construir e testar sem gastar dinheiro real.

Alguns endpoints da API (orders e events) são restritos pela OpenSea para evitar uso indevido. Para construir com esses endpoints, você pode solicitar uma chave de API no portal de desenvolvedores da OpenSea.

Agora, vamos explorar mais detalhadamente os modelos de API da OpenSea, e discutir o escopo e a função de cada um. Endpoints e chamadas de API populares também são fornecidos abaixo.

1. Contracts

Um contract é um smart contract implantado na rede Ethereum. Ele está associado a uma única conta proprietária. Contracts são executados automaticamente quando termos e condições predeterminados são atendidos — no caso da OpenSea, eles existem entre compradores e vendedores de uma coleção de NFT, e são usados para executar trocas.

2. Assets

Assets representam tokens individuais originados de um contract. Eles podem pertencer a uma ou mais contas, e contêm metadados sobre cada asset. Esses dados incluem informações sobre o ID do asset, proprietário, nome e o contract em que está contido, além de mídia (a url da imagem que o asset representa) e traits definidos pelo criador. Assets é como a OpenSea se refere a NFTs.

3. Orders

Uma order é uma intenção de compra/venda de um asset submetida por uma conta. Ela existe off-chain e tem um tipo: bid ou ask. Também contém metadados necessários para fazer o match com NFTs on-chain. Há dois participantes em uma order: um maker, que gera liquidez e atua como primeiro a se mover em uma venda ao declarar intenção de vender ou comprar/dar um bid em um item, e um taker, que consome liquidez e atua como segundo a se mover em uma venda ao comprar ou aceitar um bid no item. Orders podem ser agrupadas dentro de uma coleção específica.

4. Events

Um event representa uma mudança de estado em um asset. Existem events on-chain, como transfers, sales e mints, além de events off-chain, como bids e listings. Events podem ser privados.

5. Accounts

Accounts representam usuários no marketplace da OpenSea por meio de seus endereços de carteira e nomes de usuário associados. Elas podem possuir um ou mais assets, e atuar como makers ou takers em uma order.

6. Collections

Uma collection é um agrupamento dos assets em um ou mais contracts. Elas contêm metadados como informações de royalty e links sociais, e têm um ou mais editores autorizados. Collections existem inteiramente off-chain. Elas estão associadas a metadados como royalties do criador e descrições. Algumas collections de NFT populares incluem Bored Ape Yacht Club, CryptoPunks e Crypto Coven.

Alguns endpoints e chamadas de API populares incluem:

• Get/ Assets Busca uma lista de tokens com base em critérios de filtragem (como asset_contract_address ou collection_slug)

• GET /asset/:contract_address/:token_id

  • Busca informações detalhadas sobre um token específico, incluindo uma lista de proprietários para tokens ERC-1155 e todas as orders abertas em um token.

• GET /collections

  • Busca uma lista de collections. Também suporta opções de filtragem, como asset_owner.

• GET /collections/:slug/stats

  • Busca informações estatísticas sobre uma collection específica, incluindo um floor price atualizado.

• GET /events

  • Busca uma lista de events com base em filtros.
  • Requer um cabeçalho de chave de API (X-API-KEY: {KEY}).

• GET /orders

  • Busca uma lista de orders. Pode ser modificada com opções de filtragem como tipo de order ou um maker ou taker específico.

Você pode encontrar uma lista completa das chamadas e endpoints da API da OpenSea aqui.

2. Ferramentas de SDK

As ferramentas de SDK da OpenSea são um pacote npm disponível para desenvolvedores web que buscam construir funcionalidades de e-commerce em suas aplicações. Por meio da biblioteca JavaScript do SDK, você pode construir marketplaces nativos para compra e venda de NFTs sem necessidade de implantar smart contracts ou orderbooks de backend.

O SDK da OpenSea é suportado pela REST API que exploramos acima, e utiliza Web3.js (um pacote popular para interações com EVM) para viabilizar interações com a blockchain na criação e execução de orders de NFT.

O SDK suporta funcionalidades como buscar assets, fazer ofertas, criar listings e vender itens, executar crowdsales, buscar orders, comprar itens, aceitar ofertas e transferir itens ou moedas (presentear).

Também oferece um conjunto avançado de recursos que inclui a capacidade de agendar listings futuros, comprar itens para outros usuários, fazer transferências em lote de NFTs, criar bundles de NFTs, usar tokens ERC-20 como pagamento em vez de Ether, criar leilões privados, compartilhar taxas de venda com a OpenSea e escutar events.

É fácil de configurar (via npm install) e é integrado nativamente à exchange da OpenSea para criar e executar orders de compra/venda diretamente.

Você pode instalar e explorar a funcionalidade da biblioteca JavaScript SDK da OpenSea aqui.

Adoção pela comunidade e perspectivas

A plataforma de desenvolvimento da OpenSea tem visto ampla adoção em toda a comunidade Web3. Ela está integrada a produtos como Coinbase Wallet, MetaMask, Rainbow, 3Box, Opera Wallet, Trust Wallet, Editorial, Balance, CryptoGoods, e mais recentemente, o Twitter, quando este adicionou suporte a fotos de perfil em NFT.

Essa dependência quase generalizada do mercado em relação ao índice de API centralizado da OpenSea se mostrou problemática. Nas últimas semanas, a OpenSea passou por uma série de "falhas de banco de dados" e, como resultado, diversos serviços que dependem das APIs da OpenSea ficaram incapazes de exibir NFTs. Embora isso não afete os tokens subjacentes ou a blockchain, resulta em tempo de inatividade prolongado para todos os serviços voltados ao usuário que dependem de dados de NFT durante a duração da falha da OpenSea.

Essas falhas resultaram em mais discussões sobre a falta de descentralização entre os serviços no espaço de NFT, e em todo o ecossistema Web3 mais amplo. Nesse sentido, há alguns projetos em desenvolvimento que buscam diversos níveis de descentralização do índice de NFT, mas ainda não há nenhum player totalmente descentralizado no mercado.

De qualquer forma, os eventos recentes indicam que desenvolvedores devem considerar todos os principais provedores de API de NFT antes de decidir se usarão a OpenSea.

Alternativas à OpenSea

Além da OpenSea, algumas das APIs de NFT mais amplamente usadas e completas estão detalhadas abaixo. É importante observar que atualmente não há nenhum serviço que ofereça um equivalente ao SDK da OpenSea para a criação de marketplaces de NFT e recursos associados.

1. Alchemy NFT API

A Alchemy, uma plataforma de infraestrutura de desenvolvimento Web3, anunciou recentemente o lançamento de sua NFT API, que permite acesso a metadados de NFT tanto para ERC-721 quanto para ERC-1155, de forma muito semelhante à OpenSea. Atualmente ela suporta o acesso a metadados de NFTs em múltiplas blockchains, a localização do proprietário de um NFT, e atualizações de informações em tempo real, entre outros recursos. A API da Alchemy está disponível em Mainnets para Ethereum, Polygon e Flow, com suporte planejado para outras, começando por Solana e Avalanche, e em Testnets para Ethereum e Polygon. Atualmente ela dá suporte a plataformas de NFT como Adobe Behance, Shopify, Dapper Labs e SuperRare, entre outras.

Você pode ler mais sobre a NFT API da Alchemy aqui e encontrar a documentação aqui.

2. NFT port

Outro provedor de API de NFT é a NFTPort, uma plataforma de infraestrutura de NFT, que suporta recursos como:

• Cunhagem de NFTs na chain Polygon.
• Implantação de contracts compatíveis com a OpenSea com suporte a NFTs dinâmicos, além de suporte planejado para gerenciamento programático de royalties.
• Indexação em tempo real e cache de dados de NFT, com dados de transações/orders on-chain.
• APIs mais avançadas que incluem busca de NFT multi-chain, recomendações de NFT e detecção de NFTs falsificados.

Você pode ler mais sobre a NFTPort aqui e encontrar a documentação aqui.

3. Uniswap token lists

Para desenvolvedores que gostam da ideia de um índice totalmente descentralizado para dados de NFT, as Token Lists do Uniswap atuam como um meio-termo entre um nível de centralização similar ao da OpenSea e coleções de NFTs curadas pessoalmente e inseridas em carteiras por usuários individuais da rede. Com a solução do Uniswap, a comunidade pode se reunir para listar collections de NFT, criando descentralização e adicionando confiança ao processo de indexação.

Você pode ler mais sobre a tentativa do Uniswap de descentralizar ainda mais as interfaces de NFT aqui e criar sua própria lista de tokens aqui.

4. Indexação totalmente descentralizada... algum dia em breve?

Em resposta às recentes falhas da OpenSea, Dan Finlay, um dos fundadores da MetaMask, descreveu algumas alternativas à dependência centralizada da OpenSea aqui.

Em sua publicação, ele argumenta que: "uma solução melhor é tornar a detecção de assets um ato de consentimento centrado no cliente."

Via EIP-747, a MetaMask já permite que um site sugira um asset personalizado à carteira do usuário, com a carteira se tornando o índice de assets, sem exigir nenhum servidor central. A MetaMask, ao que parece, pretende expandir essa funcionalidade para incluir NFTs, criando um sistema totalmente descentralizado que também melhora o desempenho.

À medida que mais e mais dessas APIs de NFT chegam ao mercado, os desenvolvedores têm cada vez mais opções, não apenas quanto ao nível de descentralização que funciona melhor para eles e seus projetos, mas também na escolha do provedor desses serviços, resultando em menos falhas em todo o mercado.

Considerações finais

A plataforma de desenvolvimento da OpenSea para NFTs é robusta, completa e fácil de implantar e usar. Ela oferece recursos extensos de leitura e escrita de dados para desenvolvedores que buscam entrar no espaço de NFT, independentemente de desejarem interagir diretamente com smart contracts. É o principal provedor de mercado do serviço de API de NFT, e por boas razões.

Embora a API da OpenSea em si seja relativamente confiável, a dependência generalizada das ferramentas da empresa significa que, se ela falhar, como nas últimas semanas, vai arrastar grande parte do mercado de NFT junto. Para reduzir suficientemente o risco no espaço, os desenvolvedores devem continuar explorando uma variedade de opções descentralizadas e centralizadas sobre as quais construir seus projetos, e os provedores de infraestrutura devem trabalhar para igualar e competir com o conjunto poderoso de recursos da OpenSea.

Independentemente da API que os desenvolvedores escolham, o espaço de NFT está avançando rapidamente rumo a uma adoção generalizada e inovação sustentada, à medida que o ecossistema e as ferramentas em torno dessa classe de ativos continuam a crescer. Nunca houve um momento melhor para começar como desenvolvedor Web3!