{"id":18877580,"url":"https://github.com/nftstorage/python-client","last_synced_at":"2025-04-14T18:31:49.692Z","repository":{"id":47429550,"uuid":"353384351","full_name":"nftstorage/python-client","owner":"nftstorage","description":"A client library for the Classic NFT.Storage service.","archived":false,"fork":false,"pushed_at":"2024-07-03T04:45:50.000Z","size":94,"stargazers_count":18,"open_issues_count":1,"forks_count":8,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-28T07:02:26.925Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nftstorage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-31T14:27:18.000Z","updated_at":"2024-12-04T01:12:04.000Z","dependencies_parsed_at":"2022-09-23T00:10:26.939Z","dependency_job_id":null,"html_url":"https://github.com/nftstorage/python-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fpython-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fpython-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fpython-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fpython-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nftstorage","download_url":"https://codeload.github.com/nftstorage/python-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248936752,"owners_count":21186097,"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":[],"created_at":"2024-11-08T06:20:04.795Z","updated_at":"2025-04-14T18:31:49.392Z","avatar_url":"https://github.com/nftstorage.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nft.storage\n_This client was generated via the OpenAPI schema and is experimental, unsupported, and may not work at all!_\n\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Product Decommission Notice\n\n### Important Update\n\nHello from NFT.Storage!\n\nAs of June 30, 2024, we have officially decommissioned NFT.Storage Classic uploads. This means that NFT.Storage Classic, including NFTUp, the Classic web app, Classic APIs, Classic SDK, and Pinning API, will no longer accept new uploads/pins.\n\n### What This Means for You\n\n**Service Termination:** NFT.Storage Classic will no longer accept new uploads. However, retrieval of existing data remains operational.\n\n**Data Access:** Don't forget, we're still keeping a copy of your NFT.Storage Classic data available in the NFT.Storage Gateway and in the decentralized Filecoin Network. However, over time, latency and availability may degrade.\n\n**Support:** We’ll be working with the newly formed NFT.Storage community to determine what changes, if any, will impact NFT.Storage Classic data latency and availability in the future. Join the community [Join the community](https://nft.storage/join-us) to have your say. We will keep you informed by email and on Twitter/X.\n\n### Transition to the New Version\n\nFor the new version of NFT.Storage, first mint your NFTs, then send us the NFT data—metadata and imagery CIDs, blockchain(s) minted on, contract address, and token IDs. We will preserve these in long-term Filecoin storage. Note that you need to upload the data to IPFS separately. Your NFTs will also be included in the NFT Token Checker, a tool for block explorers, marketplaces, and wallets to show verification that NFT collections, tokens, and CIDs are preserved by NFT.Storage.\n\n### Recommended Hot Storage Alternatives\n\nWe’re excited to announce our partnerships with Pinata and Lighthouse for hot storage solutions. As an NFT.Storage user, you support our platform when you choose Pinata and Lighthouse and use our referral links, helping to sustain our valuable public goods. [Learn more here](https://nft.storage/blog/announcing-our-new-partnerships-with-pinata-and-lighthouse).\n\n**Pinata:** Offers flexible plans and powerful, easy-to-use tools for managing your data on IPFS. Use code NFTSTORAGE50 at checkout to enjoy 50% off your first month. [Sign up today](https://pinata.cloud).\n\n**Lighthouse:** An IPFS provider with unique payment options for NFT longevity. They offer affordability and flexibility for all your IPFS needs, including a pay-once and store-forever option. [Sign up today](https://lighthouse.storage).\n\n### Contact Us\n\nFor any questions or assistance, contact us [contact us](https://nft.storage/contact-us). Together, we look forward to a promising future for NFT.Storage and the broader NFT ecosystem.\n\nBest regards,  \nThe NFT.Storage Team\n\n\n## Requirements.\n\nPython \u003e= 3.6\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/nftstorage/python-client.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/nftstorage/python-client.git`)\n\nThen import the package:\n```python\nimport nft_storage\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport nft_storage\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport nft_storage\nfrom pprint import pprint\nfrom nft_storage.api import nft_storage_api\nfrom nft_storage.model.check_response import CheckResponse\nfrom nft_storage.model.delete_response import DeleteResponse\nfrom nft_storage.model.error_response import ErrorResponse\nfrom nft_storage.model.forbidden_error_response import ForbiddenErrorResponse\nfrom nft_storage.model.get_response import GetResponse\nfrom nft_storage.model.list_response import ListResponse\nfrom nft_storage.model.unauthorized_error_response import UnauthorizedErrorResponse\nfrom nft_storage.model.upload_response import UploadResponse\n# Defining the host is optional and defaults to https://api.nft.storage\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = nft_storage.Configuration(\n    host = \"https://api.nft.storage\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith nft_storage.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = nft_storage_api.NFTStorageAPI(api_client)\n    cid = \"bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u\" # str | CID for the NFT\n\n    try:\n        # Check if a CID of an NFT is being stored by nft.storage.\n        api_response = api_instance.check(cid)\n        pprint(api_response)\n    except nft_storage.ApiException as e:\n        print(\"Exception when calling NFTStorageAPI-\u003echeck: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.nft.storage*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*NFTStorageAPI* | [**check**](docs/NFTStorageAPI.md#check) | **GET** /check/{cid} | Check if a CID of an NFT is being stored by nft.storage.\n*NFTStorageAPI* | [**delete**](docs/NFTStorageAPI.md#delete) | **DELETE** /{cid} | Stop storing the content with the passed CID\n*NFTStorageAPI* | [**list**](docs/NFTStorageAPI.md#list) | **GET** / | List all stored files\n*NFTStorageAPI* | [**status**](docs/NFTStorageAPI.md#status) | **GET** /{cid} | Get information for the stored file CID\n*NFTStorageAPI* | [**store**](docs/NFTStorageAPI.md#store) | **POST** /upload | Store a file\n\n\n## Documentation For Models\n\n - [CheckResponse](docs/CheckResponse.md)\n - [CheckResponseValue](docs/CheckResponseValue.md)\n - [Deal](docs/Deal.md)\n - [DeleteResponse](docs/DeleteResponse.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [ErrorResponseError](docs/ErrorResponseError.md)\n - [Files](docs/Files.md)\n - [ForbiddenErrorResponse](docs/ForbiddenErrorResponse.md)\n - [ForbiddenErrorResponseError](docs/ForbiddenErrorResponseError.md)\n - [GetResponse](docs/GetResponse.md)\n - [Links](docs/Links.md)\n - [LinksFile](docs/LinksFile.md)\n - [ListResponse](docs/ListResponse.md)\n - [NFT](docs/NFT.md)\n - [Pin](docs/Pin.md)\n - [PinStatus](docs/PinStatus.md)\n - [UnauthorizedErrorResponse](docs/UnauthorizedErrorResponse.md)\n - [UnauthorizedErrorResponseError](docs/UnauthorizedErrorResponseError.md)\n - [UploadResponse](docs/UploadResponse.md)\n\n\n## Documentation For Authorization\n\n\n## bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\n\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in nft_storage.apis and nft_storage.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from nft_storage.api.default_api import DefaultApi`\n- `from nft_storage.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport nft_storage\nfrom nft_storage.apis import *\nfrom nft_storage.models import *\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fpython-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnftstorage%2Fpython-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fpython-client/lists"}