FilSwan API
This is a Postman Collection for the FilSwan API v2 endpoints. The page below describes different components of our API offering.
Authorization
These endpoints return details about Authorization.
Get Auth Token
POST
https://api.filswan.com/auth/login
This endpoint allows you to get an JWT Bearer Token (auth_token) from email and password. The auth_token can be used for generate other API Keys.
Request Body
Generate API Key
POST
https://api.filswan.com/user/api_keys/jwt
This endpoint allows you to issue new API keys for their account programmatically. The only key-type that can be used to issue new keys is the login user's JWT Bearer Token. The purpose of this endpoint is to allow for programmatic creation of API keys that may be used for multiple projects, individual users, or a variety of other use cases where a single API key pair across an account is not sufficient. This endpoint will return three values: The API Key, the API Secrect, and a JWT Bearer Token. Make sure to record the API Secret and the JWT as they will not be accessible again.
Request Body
Generate JWT token
POST
https://api.filswan.com/user/api_keys/jwt
To use the bearer authentication model, you will need the JWT that is generated using this API. This token can be used as an Authorization header for all your API requests in the following format: "Authorization": "Bearer YOUR_JWT"
Request Body
Miners
These endpoints return details about storage providers specified by the requested IDs.
List Storager Provider
GET
https://api.filswan.com/miners?limit={{limit}}&offset={{offset}}&location={{location}}&offline_deal_available={{offline_deal_available}}&status={{status}}&sort_by={{sort_by}}&order={{order}}
This endpoint allows you to get a list of storage providers.
Path Parameters
Single Storage Providers Detail
GET
https://api.filswan.com/miners/{{miner_id}}
This endpoint allows you to get details of the miner specified by the requested provider ID.
Update Storage Provider Info
POST
https://api.filswan.com/miner/info
This endpoint allows you to update your storage provider information.
Headers
Request Body
Tasks
These endpoints return details about tasks specified by the requested IDs.
Public Tasks
List Public Tasks
GET
https://api.filswan.com/tasks?created_after={{created_after}}&has_miner={{has_miner}}&status={{status}}&is_public={{is_public}}&task_name={{task_name}}&type={{type}}&tags={{tags}}&max_price={{max_price}}&min_price={{min_price}}
This endpoint allows you to get a list of public tasks.
Path Parameters
Client Tasks
List User Tasks
GET
https://api.filswan.com/tasks?limit={{limit}}&offset={{offset}}
This endpoint allows you to get details of tasks created by a client.
Path Parameters
Headers
Single Task Details
GET
https://api.filswan.com/tasks/{{task_uuid}}?limit={{limit}}&offset={{offset}}
This endpoint allows you to get details about the task specified by the requested task UUID.
Path Parameters
Create Task
POST
https://api.filswan.com/tasks
This endpoint allows you to create a new task on FilSwan Platform.
Headers
Request Body
Storage Provider Tasks
List Storage Provider Tasks
GET
https://api.filswan.com/my_miner/tasks?limit={{limit}}&offset={{offset}}
This endpoint allows you to get a list of tasks when your role is a miner.
Path Parameters
Deals.
Get storage provider's deals by status
GET
https://api.filswan.com/offline_deals/{{miner_fid}}?deal_status={{deal_status}}&limit={{limit}}&offset={{offset}}
This endpoint allows you to get a list of offline deals belongs to a specified provider ID.
Path Parameters
Headers
Update Single Deal Details
PUT
https://api.filswan.com/my_miner/deals/<deal_cid>
Headers
Request Body
Update Deal Status
PUT
https://api.filswan.com/my_miner/tasks/<task_uuid>/deals/<deal_cid>
Headers
Request Body
List of Supported API Methods
The list below documents the API methods that the FilSwan platform currently supports. When a response payload is present, all responses are returned in JSON format.
Get Auth Token
Generate API Key
Generate JWT token
List storage providers
Single storage provider
List Public Tasks
List User Tasks
Single task
Create Task
List storage provider Tasks
Get storage provider's deals by status
Update Single deal details
Update deal status of a task
Find out more about our APIs.
If you have an API-related question, you can also discuss in the developer community forum.
Last updated