Search…
⌃K

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.
post
https://api.filswan.com
/auth/login
Get Auth Token
post
https://api.filswan.com
/user/api_keys/jwt
Generate API Key
post
https://api.filswan.com
/user/api_keys/jwt
Generate JWT token

Miners

These endpoints return details about storage providers specified by the requested IDs.
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}}
List Storager Provider
get
https://api.filswan.com
/miners/{{miner_id}}
Single Storage Providers Detail
post
https://api.filswan.com
/miner/info
Update Storage Provider Info

Tasks

These endpoints return details about tasks specified by the requested IDs.

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}}
List Public Tasks

Client Tasks

get
https://api.filswan.com
/tasks?limit={{limit}}&offset={{offset}}
List User Tasks
get
https://api.filswan.com
/tasks/{{task_uuid}}?limit={{limit}}&offset={{offset}}
Single Task Details
post
https://api.filswan.com
/tasks
Create Task

Storage Provider Tasks

get
https://api.filswan.com
/my_miner/tasks?limit={{limit}}&offset={{offset}}
List Storage Provider Tasks

Deals.

get
https://api.filswan.com
/offline_deals/{{miner_fid}}?deal_status={{deal_status}}&limit={{limit}}&offset={{offset}}
Get storage provider's deals by status
put
https://api.filswan.com
/my_miner/deals/<deal_cid>
Update Single Deal Details
put
https://api.filswan.com
/my_miner/tasks/<task_uuid>/deals/<deal_cid>
Update Deal Status

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.