Skip to content

README.md

Latest commit

 

History

History
77 lines (51 loc) · 4.34 KB

README.md

File metadata and controls

77 lines (51 loc) · 4.34 KB

NFT.Storage logo

Free decentralized storage and bandwidth for NFTs on IPFS and Filecoin.

Twitter Follow

April 2024 Update

To align our services more closely with our community's needs and ensure the sustainability of our model, we're updating our service offerings. We'll continue to offer the current product under the name NFT.Storage Classic (classic.nft.storage) for existing uploads prior to 30 June 2024 , but no new uploads to the Classic product will be accepted as of 30 June 2024 at 5pm EST. New account registrations will no longer be accepted for: * The original NFT.Storage web app, API, and SDK * NFTUp * Pinning API

Your benefits as an existing account holder:

  • Continue to upload off-chain NFT data using the current products through 30 June 2024, at 5 PM EST
  • Maintain access to your links through the NFT.Storage Gateway
  • All NFT data you’ve already uploaded and will upload before 30 June 2024, will continue to be safely stored and accessible via IPFS and in the Filecoin Network's long-term storage, though over time latency and availability may degrade.

Try the new version of NFT.Storage, focused on NFT preservation through Filecoin storage here: https://nft.storage

Table of Contents

Client Libraries

The JS client library is the official and supported client to nft.storage. Other libraries listed have been generated from the OpenAPI schema and are experimental, unsupported and may not work at all!

  • JavaScript
  • Go (Generated from OpenAPI schema)
  • Java (Generated from OpenAPI schema)
  • PHP (Generated from OpenAPI schema)
  • Python (Generated from OpenAPI schema)
  • Ruby (Generated from OpenAPI schema)
  • Rust (Generated from OpenAPI schema)
  • Unity (C#)

HTTP API

Check out the HTTP API documentation.

Examples

See the examples directory in this repository for some example projects you can use to get started.

The examples/client directory contains projects using the JS client library in the browser and node.js.

In [examples/ucan-node] you can find an example of using ucan.storage for delegated authorization using User Controlled Authorization Networks (UCAN).

Developer Tools

We've created some scripts to help developers with bulk imports, status checks, file listings and more:

https://github.com/nftstorage/nft.storage-tools

Development

Instructions for setting up a development environment can be found in DEVELOPMENT.md. Please let us know if anything is missing.

Contributing

Feel free to join in. All welcome. Open an issue!

If you're opening a pull request, please see the guidelines in DEVELOPMENT.md on structuring your commit messages so that your PR will be compatible with our release process.

License

Dual-licensed under MIT + Apache 2.0