This is a Postman Collection for the FilSwan API v2 endpoints.
\nIf you have an API-related question, you can also discuss in the developer community forum.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13140808","collectionId":"7399d6e5-3d45-4a63-b8a5-40582cfa4615","publishedId":"TWDZJbzV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-02-23T21:54:53.000Z"},"item":[{"name":"Authorization","item":[{"name":"sign up","id":"423915ea-caa8-454d-94c7-ffcb99906a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"ccao2@nbai.io\",\n \"password\":\"123456h\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/auth/register","description":"This endpoint allows an user get an JWT Bearer Token (auth_token) from email and password.
\nThe auth_token can be used for generate other API Keys.
\n","urlObject":{"protocol":"http","port":"5000","path":["auth","register"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d1fffd22-3d5c-4552-a492-8648d674e9fe","name":"signup","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"my-email\",\n \"password\":\"my-password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com//auth/login"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"auth_token\": \"eyJ0eXAiOiJKV1QiLCJhbGci1iJIUzI1NiJ9.eyJleHAi5jE2XTM4NDY2ODUsImlhdCI6MTYxMzc2MDI4NSwic3ViIjoxODB9.nqVR7pZ5voIEotp85zA2dEzIEmAMbiWcCBkvT06ILu4\",\n \"message\": \"Successfully logged in.\",\n \"status\": \"success\"\n}"}],"_postman_id":"423915ea-caa8-454d-94c7-ffcb99906a70"},{"name":"Get Auth Token","id":"aaa28f08-483a-404c-8410-7bc317fe47af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"my-email\",\n \"password\":\"my-password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com/auth/login","description":"This endpoint allows an user get an JWT Bearer Token (auth_token) from email and password.
\nThe auth_token can be used for generate other API Keys.
\n","urlObject":{"protocol":"https","path":["auth","login"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"cbb03b21-f862-4c93-9f31-c9812d76270f","name":"Get Auth Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"my-email\",\n \"password\":\"my-password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com//auth/login"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"auth_token\": \"eyJ0eXAiOiJKV1QiLCJhbGci1iJIUzI1NiJ9.eyJleHAi5jE2XTM4NDY2ODUsImlhdCI6MTYxMzc2MDI4NSwic3ViIjoxODB9.nqVR7pZ5voIEotp85zA2dEzIEmAMbiWcCBkvT06ILu4\",\n \"message\": \"Successfully logged in.\",\n \"status\": \"success\"\n}"}],"_postman_id":"aaa28f08-483a-404c-8410-7bc317fe47af"},{"name":"Generate API Key","id":"fcad85b0-2450-407c-9515-99abe2637fa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows an user 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.
\nThe 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.
\nThis endpoint will return three values: The API Key, the API Secret, and a JWT Bearer Token.
\nMake sure to record the API Secret and the JWT as they will not be accessible again.
\n","urlObject":{"protocol":"http","port":"5000","path":["user","api_keys"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0cf48a4b-a9a9-4543-bbd7-bd7286e7ecb7","name":"Generate API Key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key_name\":\"keyname\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com/user/api_keys/jwt"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"auth_token\": {\n \"access_token\": \"6ca9a6575b7255b3f15xxxxxxxxxxx17a1\",\n \"apikey\": \"7WIhxxxxxxxxxx0YSmGw\",\n \"created_on\": \"1614229867\",\n \"jwt\": \"eyJ0eXAiOiJxxxxxxxxxxxOiJIUzI1NiJ9.eyJleHAiOjExxxxxxxxxxxxDIyOTg2Nywic3ViIjoiN1dJaGM5bkNrR1gzVk9VczBZU21HdyJ9.CO5oXVnDGcTwxxxxxxxI6xC5IBF2NdJkt34\",\n \"key_name\": \"test\",\n \"status\": \"Created\"\n },\n \"message\": \"api token successfully created.\",\n \"status\": \"success\"\n}"}],"_postman_id":"fcad85b0-2450-407c-9515-99abe2637fa3"},{"name":"Generate JWT token","id":"cfb49be3-d445-44e7-b104-8a3d93cc0e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"access_token\": \"my-access-token\",\n \"apikey\": \"my-apikey\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com/user/api_keys/jwt","description":"To use the bearer authentication model, you will need the JWT that is generated using this API.
\nThis token can be used as an Authorization header for all your API requests in the following format:\n\"Authorization\": \"Bearer YOUR_JWT\"
\n","urlObject":{"protocol":"https","path":["user","api_keys","jwt"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"f9bb954b-fc3e-4150-9b25-e58341681f63","name":"Generate JWT token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"access_token\": \"my-access-token\",\n \"apikey\": \"my-apikey\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.filswan.com/user/api_keys/jwt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Mon, 15 Feb 2021 14:16:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"234"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"api_key\": \"my-apikey-name\",\n \"jwt\": \"my-api-token\"\n },\n \"status\": \"success\"\n}"}],"_postman_id":"cfb49be3-d445-44e7-b104-8a3d93cc0e59"}],"id":"7f3b22c1-be7e-449b-8872-6037f6d14dee","description":"These endpoints return details about Authorization.
\n","_postman_id":"7f3b22c1-be7e-449b-8872-6037f6d14dee"},{"name":"Miners","item":[{"name":"List miners","id":"4496c118-a054-4939-a726-a7123bac2f34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"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}}","description":"This endpoint returns details about miners, default 10.
\n","urlObject":{"protocol":"https","path":["miners"],"host":["api","filswan","com"],"query":[{"description":{"content":"Integer.\nOptional.\nNumber of items in one page.\nDefault: 10
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Integer.\nOptional.\nPage number, starts from 0.\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"},{"description":{"content":"String.\nOptional.\nThe location of miners. If empty, it shows miners at all locations.\nPossible values are: Global, Asia, Africa, North America, South America, Europe, Oceania
\n","type":"text/plain"},"key":"location","value":"{{location}}"},{"description":{"content":"Integer.\nOptional. Miner accept offline deals or not. If empty, it shows all miners.\nPossible values are:
\nString.\nOptional.\nThe status of a miners. If empty, it shows all miners in any status.\nPossible values are:
\nString.\nOptional.\nPossible values are:
\nString.\nOptional.\nPossible values are:
\nThis endpoint returns details about the miner specified by the requested ID.
\n","urlObject":{"protocol":"https","path":["miners","{{miner_id}}"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"66f56d51-0ebe-45d0-b5b6-2399aa7c438f","name":"Single miner","originalRequest":{"method":"GET","header":[],"url":"https://api.filswan.com/miners/{{miner_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"miner\": {\n \"contact_info\": \"Charles Cao-NBFS\",\n \"location\": \"North America\",\n \"max_piece_size\": \"32 GiB\",\n \"min_piece_size\": \"8 MiB\",\n \"miner_id\": \"f019104\",\n \"offline_deal_available\": true,\n \"price\": \"1.8000000000E-8\",\n \"score\": 0,\n \"status\": \"Active\",\n \"update_time_str\": \"1609973690\",\n \"verified_price\": \"0E-18\"\n }\n },\n \"status\": \"success\"\n}"}],"_postman_id":"ff308342-4cb6-4a08-873b-4bca83aa969f"}],"id":"2173b707-7a05-408c-9ad0-9acce9608250","description":"These endpoints return details about miners specified by the requested IDs.
\n","event":[{"listen":"prerequest","script":{"id":"d7ba0e25-2ed1-41c2-b100-eb41e3109a47","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31100fa2-0d05-47ac-95cf-778b0306f822","type":"text/javascript","exec":[""]}}],"_postman_id":"2173b707-7a05-408c-9ad0-9acce9608250"},{"name":"Tasks","item":[{"name":"Public Tasks","item":[{"name":"List Public Tasks","id":"4ba38ee7-0102-4439-abea-193ae846c47a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"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}}","urlObject":{"protocol":"https","path":["tasks"],"host":["api","filswan","com"],"query":[{"description":{"content":"Integer.\nOptional.\nFilter tasks created after a specific time. If empty, show all tasks created at any time.\nValue is Unix timestamp in seconds.
\n","type":"text/plain"},"key":"created_after","value":"{{created_after}}"},{"description":{"content":"Integer.\nOptional.\nFilter tasks had already been designated to a miner or not. If empty, show all tasks. Possible values are:
\nString.\nOptional.\nFilter tasks in various status. If empty, show tasks in any status. Possible values are:
\nInteger.\nOptional.\nTasks are public or private. The possible values are:
\nString.\nOptional.\nSearch tasks by task name.
\n","type":"text/plain"},"key":"task_name","value":"{{task_name}}"},{"description":{"content":"String.\nOptional.\nThe deals in this task is verified or not. Possible values are:
\nString.\nOptional.\nSearch tasks by tags. Use comma to seperate multiple tags.
\n","type":"text/plain"},"key":"tags","value":"{{tags}}"},{"description":{"content":"Float.\nOptional.\nMax price per Gib per epoch.
\n","type":"text/plain"},"key":"max_price","value":"{{max_price}}"},{"description":{"content":"Float.\nOptional.\nMin price per Gib per epoch.
\n","type":"text/plain"},"key":"min_price","value":"{{min_price}}"}],"variable":[]}},"response":[{"id":"e3223e15-0442-43c1-8470-f8e26b0f4ccb","name":"List tasks","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.filswan.com/tasks?is_public=1","protocol":"https","host":["api","filswan","com"],"path":["tasks"],"query":[{"key":"created_after","value":"1614190226","description":"Optional. Filter tasks created after a specific time. If empty, show all tasks created at any time.\nValue is Unix timestamp in seconds","disabled":true},{"key":"has_miner","value":"0","description":"Optional. Filter tasks had already been designated to a miner or not. If empty, show all tasks. Possible values:\n- 1. Tasks had already been designated to a miner.\n- 0. Tasks had not been designated to a miner.","disabled":true},{"key":"status","value":"Created","description":"Optional. Filter tasks in various status. If empty, show tasks in any status. Possible values:\n- Created. Task is created.\n- Completed. Task is completed.","disabled":true},{"key":"is_public","value":"1","description":"Optional. Tasks are public or private. The possible values are:\n- 1. Show public tasks. Login is not required to get public tasks.\n- If empty or any other value, show private tasks. Login is required and it only shows your tasks."},{"key":"task_name","value":"","description":"Optional. Search tasks by task name.","disabled":true},{"key":"type","value":"regular","description":"Optional. The deals in this task is verified or not. Possible values\n- regular\n- verified","disabled":true},{"key":"tags","value":"","description":"Optional. Search tasks by tags. Use comma to seperate multiple tags.","disabled":true},{"key":"max_price","value":"10","description":"Optional. Max price per Gib per epoch.","disabled":true},{"key":"min_price","value":"0","description":"Optional. Min price per Gib per epoch.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Wed, 24 Feb 2021 18:31:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4112"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"task\": [\n {\n \"bid_count\": 0,\n \"created_on\": \"1614106962\",\n \"deal_count\": 22,\n \"description\": \"Enter up to 5 tags that best describe your task. Miner will use these tags to find task they are most interested and experienced in.\\n\",\n \"expire_days\": null,\n \"is_public\": 1,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": null,\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"import_deal_template (3).csv\",\n \"task_id\": 145,\n \"task_name\": \"COMMON-CRAWL\",\n \"type\": \"regular\"\n },\n {\n \"bid_count\": 1,\n \"created_on\": \"1613713470\",\n \"deal_count\": 1,\n \"description\": \"NBFS fix auto import for API TOKEN, 8gb file, 160gb after seal\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"0E-18\",\n \"min_price\": \"0E-18\",\n \"miner_id\": null,\n \"status\": \"Created\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"20210203_csv-verified-public.csv\",\n \"task_id\": 125,\n \"task_name\": \"NBFS fix auto import\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 2,\n \"created_on\": \"1613682476\",\n \"deal_count\": 1,\n \"description\": \"Total of 320Gb verified deals will be 3,2Tb of power\\nNeeds to be in the EU\",\n \"expire_days\": 3,\n \"is_public\": 1,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": null,\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"deal-empty-for-now.csv\",\n \"task_id\": 124,\n \"task_name\": \"10x 32Gb verified sectors - 2\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 0,\n \"created_on\": \"1613682370\",\n \"deal_count\": 1,\n \"description\": \"Total of 320Gb verified deals will be 3,2Tb of power\\nNeeds to be in the EU\",\n \"expire_days\": 3,\n \"is_public\": 1,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": null,\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"deal-empty-for-now.csv\",\n \"task_id\": 123,\n \"task_name\": \"10x 32Gb verified sectors\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 2,\n \"created_on\": \"1613418605\",\n \"deal_count\": 4,\n \"description\": \"Designed for test miner client function, big winner will get 160gb after testing.\",\n \"expire_days\": 2,\n \"is_public\": 1,\n \"max_price\": \"1.00000000000E-7\",\n \"min_price\": \"0E-18\",\n \"miner_id\": \"f047419\",\n \"status\": \"Created\",\n \"successful_deal_count\": 1,\n \"tags\": \"NBFS\",\n \"task_file_name\": \"f047419-0219.csv\",\n \"task_id\": 121,\n \"task_name\": \"NBFS 9GB Miner client test\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 3,\n \"created_on\": \"1613174281\",\n \"deal_count\": 2,\n \"description\": \"This deal is for testing email notifications. you will get 160gb after sealing\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"1.0000000E-11\",\n \"min_price\": \"0E-18\",\n \"miner_id\": \"f03624\",\n \"status\": \"Created\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"f03624_20210215.csv\",\n \"task_id\": 120,\n \"task_name\": \"NBFS 9GB\",\n \"type\": null\n },\n {\n \"bid_count\": 2,\n \"created_on\": \"1613161109\",\n \"deal_count\": 2,\n \"description\": \"10x verified deal.will be 160gb after seal\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"1.0000000E-11\",\n \"min_price\": \"0E-18\",\n \"miner_id\": \"f047419\",\n \"status\": \"Completed\",\n \"successful_deal_count\": 1,\n \"tags\": null,\n \"task_file_name\": \"f047419_20210212.csv\",\n \"task_id\": 119,\n \"task_name\": \"NBFS 9GB\",\n \"type\": null\n },\n {\n \"bid_count\": 6,\n \"created_on\": \"1612567274\",\n \"deal_count\": 1,\n \"description\": \"Verified deal file with 10x sealing capability ,it will be 320GB after proving\\n\",\n \"expire_days\": 3,\n \"is_public\": 1,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": null,\n \"status\": \"Created\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"film1.csv\",\n \"task_id\": 116,\n \"task_name\": \"Speedium-1612567082\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 5,\n \"created_on\": \"1612448401\",\n \"deal_count\": 2,\n \"description\": \"9Gb file with 10x sealing capability ,it will be 160GB after proving\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"1.50000000000E-7\",\n \"min_price\": \"1.00000000000E-7\",\n \"miner_id\": \"f023467\",\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": \"NA,EU\",\n \"task_file_name\": \"f023467_20210212.csv\",\n \"task_id\": 115,\n \"task_name\": \"Filbox Feb04-2 Task\",\n \"type\": \"verified\"\n },\n {\n \"bid_count\": 6,\n \"created_on\": \"1612443851\",\n \"deal_count\": 2,\n \"description\": \"Open to EU and NA miners\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"1.5000000000E-8\",\n \"min_price\": \"1.0000000000E-8\",\n \"miner_id\": \"f010446\",\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": \"filbox\",\n \"task_file_name\": \"f010446_20200210.csv\",\n \"task_id\": 114,\n \"task_name\": \"Filbox Verified deal\",\n \"type\": \"verified\"\n }\n ]\n },\n \"status\": \"success\",\n \"total_items\": 10,\n \"total_task_count\": 10\n}"}],"_postman_id":"4ba38ee7-0102-4439-abea-193ae846c47a"}],"id":"a5d67e83-0763-4308-9c42-2754bfc4a245","_postman_id":"a5d67e83-0763-4308-9c42-2754bfc4a245","description":""},{"name":"Client Tasks","item":[{"name":"List User Tasks","id":"eec28a7c-e19e-484a-b2be-f2896641bc15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.filswan.com/tasks?limit={{limit}}&offset={{offset}}","description":"This endpoint returns details about tasks created by client, default 10.
\n","urlObject":{"protocol":"https","path":["tasks"],"host":["api","filswan","com"],"query":[{"description":{"content":"Integer. \nOptional. The number of items to return in the response.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Integer. \nOptional. The offset number indicating which set of items will be returned in the response. So, the combination of offset=0 and limit=20 returns the first 20 items. The combination of offset=1 and limit=20 returns items 21 through 40.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[{"id":"8cabfd27-dc77-4aae-9c2e-8b0544046c6d","name":"Get my tasks","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.filswan.com/tasks?limit=10&offset=0&task_name=","protocol":"https","host":["api","filswan","com"],"path":["tasks"],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"0"},{"key":"task_name","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"task\": [\n {\n \"bid_count\": 0,\n \"created_on\": \"1614106596\",\n \"deal_count\": 22,\n \"description\": \"Enter up to 5 tags that best describe your task. Miner will use these tags to find task they are most interested and experienced in.\",\n \"expire_days\": null,\n \"is_public\": 0,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": \"f001122\",\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"import_deal_template (3).csv\",\n \"task_id\": 143,\n \"task_name\": \"COMMON-CRAWL\",\n \"type\": \"regular\"\n },\n {\n \"bid_count\": 0,\n \"created_on\": \"1614106085\",\n \"deal_count\": 39,\n \"description\": \"It has a General Storage Service (GS2) store unstructured data such as photos, videos, log files, backups and container images compatible with Amazon S3 cloud storage service.\",\n \"expire_days\": null,\n \"is_public\": 0,\n \"max_price\": null,\n \"min_price\": null,\n \"miner_id\": \"f001122\",\n \"status\": \"Completed\",\n \"successful_deal_count\": 0,\n \"tags\": null,\n \"task_file_name\": \"import_deal_template (3).csv\",\n \"task_id\": 142,\n \"task_name\": \"COMMON-CRAWL\",\n \"type\": \"regular\"\n }\n \n ]\n },\n \"status\": \"success\",\n \"total_items\": 2,\n \"total_task_count\": 2\n}"}],"_postman_id":"eec28a7c-e19e-484a-b2be-f2896641bc15"},{"name":"Single task","id":"93be1b5c-1cc6-469b-ae08-ff2e4fb29b8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.filswan.com/tasks/{{task_id}}?limit={{limit}}&offset={{offset}}","description":"This endpoint returns details about the task specified by the requested ID.
\n","urlObject":{"protocol":"https","path":["tasks","{{task_id}}"],"host":["api","filswan","com"],"query":[{"description":{"content":"Integer.\nOptional.\nNumber of items in one page.\nDefault: 10
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Integer.\nOptional.\nPage number, starts from 0.\nDefault: 0
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[{"id":"34f159d4-8c1b-4827-a3e2-4655f1bdbab1","name":"Single task","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.filswan.com/tasks/125?limit=20&offset=0","protocol":"https","host":["api","filswan","com"],"path":["tasks","125"],"query":[{"key":"limit","value":"20"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Wed, 24 Feb 2021 18:43:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1793"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"average_bid\": \"0\",\n \"bid\": [\n {\n \"bid_id\": 26,\n \"contact_info\": \"slack: @Patrick - Factor8 Solutions\",\n \"created_on\": \"1613978960\",\n \"expire_days\": 5,\n \"min_piece_size\": \"16GB\",\n \"price\": \"0E-18\",\n \"proposal\": \"whatever you need man\",\n \"status\": \"New\",\n \"swan_user_info\": {\n \"headline\": null,\n \"miners\": [\n {\n \"location\": \"Global\",\n \"max_piece_size\": \"32 GiB\",\n \"min_piece_size\": \"256 B\",\n \"miner_id\": \"f03223\",\n \"offline_deal_available\": false,\n \"price\": \"5.000000000000000000\",\n \"score\": 0,\n \"status\": \"Deleted\",\n \"update_time_str\": \"1613951245947\",\n \"verified_price\": \"5.000000000000000000\"\n },\n {\n \"location\": \"Europe\",\n \"max_piece_size\": \"32 GiB\",\n \"min_piece_size\": \"16 GiB\",\n \"miner_id\": \"f062353\",\n \"offline_deal_available\": true,\n \"price\": \"5.0000000000E-8\",\n \"score\": 0,\n \"status\": \"Deleted\",\n \"update_time_str\": \"1613949072425\",\n \"verified_price\": \"0E-18\"\n }\n ],\n \"registered_on\": \"1613949072\",\n \"status\": \"Active\",\n \"summary\": null\n },\n \"task_id\": 125,\n \"username\": \"swancylmqovj\",\n \"won_on\": null\n }\n ],\n \"bid_count\": 1,\n \"deal\": [\n {\n \"created_at\": \"1613713470\",\n \"deal_cid\": null,\n \"file_path\": null,\n \"file_source_url\": \"https://download.nbai.io/CC-MAIN-20200918061627-20200918091627-00583-00584-00585-00586-00587-00588-00589.gz.car\",\n \"id\": 2645,\n \"md5_origin\": null,\n \"miner_id\": null,\n \"note\": null,\n \"start_epoch\": null,\n \"status\": \"Created\",\n \"task_id\": 125,\n \"updated_at\": \"1613713470\",\n \"user_id\": 21\n }\n ],\n \"deal_complete_rate\": \"0.00\",\n \"miner\": null,\n \"poster\": {\n \"complete_task_count\": 39,\n \"contact_info\": \"Charles Cao-NBFS\",\n \"member_since\": \"January 12, 2021\"\n },\n \"task\": {\n \"created_on\": \"1613713470\",\n \"description\": \"NBFS fix auto import for API TOKEN, 8gb file, 160gb after seal\",\n \"expire_days\": 4,\n \"is_public\": 1,\n \"max_price\": \"0E-18\",\n \"min_price\": \"0E-18\",\n \"miner_id\": null,\n \"status\": \"Created\",\n \"tags\": null,\n \"task_file_name\": \"20210203_csv-verified-public.csv\",\n \"task_id\": 125,\n \"task_name\": \"NBFS fix auto import\",\n \"type\": \"verified\"\n },\n \"total_deal_count\": 1\n },\n \"status\": \"success\"\n}"}],"_postman_id":"93be1b5c-1cc6-469b-ae08-ff2e4fb29b8e"},{"name":"Create Task","id":"9c2c2370-be78-4278-9f81-f191b80d77ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"task_name","value":"{{task_name}}","type":"text","description":"String.\nRequired.\nTask name you preferred.
\n"},{"key":"is_public","value":"{{is_public}}","type":"text","description":"Integer.\nRequired.\nThis task is public or private. The possible values are:
\nString.\nRequired.\nThe deals in this task is verified or not. Possible values are:
\nBinary.\nRequired.\nThe CSV file containing all deal information in the task to create.\nYou can download CSV template from here.
\n","contentType":"","value":null},{"key":"miner_id","value":"{{miner_id}}","type":"text","description":"String.\nOptional.\nThe miner id you want to designate the task to, exp. f019104.
\n"},{"key":"description","value":"{{description}}","type":"text","description":"String.\nOptional.
\n"},{"key":"tags","value":"{{tags}}","description":"String.\nOptional.Up to 5 tags.\nUse comma to seperate multiple tags.
\n","type":"text"},{"key":"max_price","value":"{{max_price}}","description":"Float.\nOptional.\nMax price per Gib per epoch.
\n","type":"text"},{"key":"min_price","value":"{{min_price}}","description":"Float.\nOptional.\nMin price per Gib per epoch.
\n","type":"text"}]},"url":"https://api.filswan.com/tasks","description":"Create a new task on Swan，if is_public=1, the task is open to bid.
\n","urlObject":{"protocol":"https","path":["tasks"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"07da7068-b0ec-4b48-82c9-96eb7b6a4c0f","name":"Create Task","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"task_name","value":"task_name","type":"text","description":"Required. Task name you preferred"},{"key":"is_public","value":"1","type":"text","description":"Required. This task is public or private. (1 is public, 0 is private)\nA public task opens bid, and a private task has a designated miner."},{"key":"type","value":"regular","type":"text","description":"Required. The deals in this task is verified or not. (value: regular/verified)"},{"key":"file","type":"file","description":"Required. The CSV file containing all deal information in the task to create.\nTemplate https://www.filswan.com/static/import_deal_template.csv","contentType":"","src":"IFSXnLf_K/import_deal_template.csv"},{"key":"miner_id","value":"","type":"text","description":"Optional."},{"key":"description","value":"","type":"text","description":"Optional."},{"key":"tags","value":"","description":"Optional.","type":"text"},{"key":"max_price","value":"","description":"Optional.","type":"text"},{"key":"min_price","value":"","description":"Optional.","type":"text"}]},"url":"https://api.filswan.com/tasks"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"filename\": \"import_deal_template.csv\"\n },\n \"status\": \"success\"\n}"}],"_postman_id":"9c2c2370-be78-4278-9f81-f191b80d77ab"}],"id":"80d1f8cb-94b5-4081-8846-e2824f7a4c95","event":[{"listen":"prerequest","script":{"id":"115223f0-76d6-421d-92dc-4b5b2c055f29","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f69e0bc7-0693-439f-8dc2-49127585786d","type":"text/javascript","exec":[""]}}],"_postman_id":"80d1f8cb-94b5-4081-8846-e2824f7a4c95","description":""},{"name":"Miner Tasks","item":[{"name":"List Miner Tasks","id":"a7bd518d-21ac-4509-9226-bc5383377ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.filswan.com/my_miner/tasks?limit={{limit}}&offset={{offset}}","urlObject":{"protocol":"https","path":["my_miner","tasks"],"host":["api","filswan","com"],"query":[{"description":{"content":"Integer. \nOptional. The number of items to return in the response.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Integer. \nOptional. The offset number indicating which set of items will be returned in the response. So, the combination of offset=0 and limit=20 returns the first 20 items. The combination of offset=1 and limit=20 returns items 21 through 40.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[],"_postman_id":"a7bd518d-21ac-4509-9226-bc5383377ccc"}],"id":"780c526a-4417-4f65-b0a4-ae2fc95cfcd3","description":"Task managed by miner. e.g task accepted from client.
\n","_postman_id":"780c526a-4417-4f65-b0a4-ae2fc95cfcd3"},{"name":"Deals","item":[{"name":"Get miner's deals by status","id":"86a0bf39-e1d5-4cb8-a25a-1d4a2f894609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.filswan.com/offline_deals/{{miner_fid}}?deal_status={{deal_status}}&limit={{limit}}&offset={{offset}}","description":"Returns a list of offline deals belongs to a specified miner ID.
\n","urlObject":{"protocol":"https","path":["offline_deals","{{miner_fid}}"],"host":["api","filswan","com"],"query":[{"description":{"content":"String. \nRequired.\nThe deal status. \nThe possible values are:
\nInteger.\nOptional.\nThe number of items to return in the response.
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Integer.\nOptional. \nThe offset number indicating which set of items will be returned in the response. So, the combination of offset=0 and limit=20 returns the first 20 items. The combination of offset=1 and limit=20 returns items 21 through 40.
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[]}},"response":[{"id":"2cee3435-2a57-43ae-ac2f-1cfa87b78c87","name":"Get my deals by status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.filswan.com/offline_deals/{{miner_fid}}?deal_status={{deal_status}}&limit={{limit}}&offset={{offset}}","protocol":"https","host":["api","filswan","com"],"path":["offline_deals","{{miner_fid}}"],"query":[{"key":"deal_status","value":"{{deal_status}}","description":"String \nRequired\nThe deal status. \nThe possible values are:\n- ReadyForImport. The deal is proposed and the car file is downloaded. Miner can start to import the deal. \n- FileImporting. The car file is being imported by miner.\n- FileImported. The car file is successfully imported, and the deal is is being sealed.\n- DealActive. The deal is sealed successfully. Deal details can be found on blockchain.\n- ImportFailed. The car file is failed to be imported, or the deal is failed to be sealed."},{"key":"limit","value":"{{limit}}","description":"Integer\nOptional\nThe number of items to return in the response."},{"key":"offset","value":"{{offset}}","description":"Integer\nOptional \nThe offset number indicating which set of items will be returned in the response. So, the combination of offset=0 and limit=20 returns the first 20 items. The combination of offset=1 and limit=20 returns items 21 through 40."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deal\": [\n {\n \"created_at\": \"1613398987\",\n \"deal_cid\": \"deal_cid\",\n \"file_path\": \"file_path\",\n \"file_source_url\": \"file_source_url\",\n \"id\": 1,\n \"md5_origin\": null,\n \"miner_id\": 1,\n \"note\": \"This is an example.\",\n \"start_epoch\": 400300,\n \"status\": \"ReadyForImport\",\n \"task_id\": 1,\n \"updated_at\": \"1613398987\",\n \"user_id\": 1\n },\n {\n \"created_at\": \"1613398987\",\n \"deal_cid\": deal_cid\",\n \"file_path\": \"file_path\",\n \"file_source_url\": \"file_source_url\",\n \"id\": 2,\n \"md5_origin\": null,\n \"miner_id\": 1,\n \"note\": \"\",\n \"start_epoch\": 400300,\n \"status\": \"ReadyForImport\",\n \"task_id\": 1,\n \"updated_at\": \"1613398987\",\n \"user_id\": 1\n }\n ]\n },\n \"status\": \"success\"\n}"}],"_postman_id":"86a0bf39-e1d5-4cb8-a25a-1d4a2f894609"},{"name":"Update Single deal details","id":"9e355b41-1b3a-4670-a166-fe83cd563bed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"status","value":"{{status}}","description":"String.\nRequired.\nThe new deal status.\nThe possible values are:
\nString.\nOptional.\nThe additional information you would like to provide regarding the deal.
\n","type":"text"},{"key":"file_path","value":"{{file_path}}","description":"String.\nOptional.\nThe path where the car file is downloaded to.
\n","type":"text"},{"key":"file_size","value":"{{file_size}}","description":"String.\nOptional.\nThe size of the car file.
\n","type":"text"}]},"url":"https://api.filswan.com/my_miner/deals/{{deal_cid}}","urlObject":{"protocol":"https","path":["my_miner","deals","{{deal_cid}}"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"f0904f34-f4e5-4bef-9f55-fb19a1c9bd1a","name":"Update Single deal details","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"status","value":"{{status}}","description":"String\nRequired\nThe new deal status.\nThe possible values are:\n- FileImporting. The car file is being imported by miner.\n- FileImported. The car file is successfully imported, and the deal is is being sealed.\n- DealActive. The deal is sealed successfully. Deal details can be found on blockchain.\n- ImportFailed. The car file is failed to be imported, or the deal is failed to be sealed.","type":"text"},{"key":"note","value":"{{note}}","description":"String\nOptional\nThe additional information you would like to provide regarding the deal.","type":"text"},{"key":"file_path","value":"{{file_path}}","description":"String\nOptional\nThe path where the car file is downloaded to.","type":"text"},{"key":"file_size","value":"{{file_size}}","description":"String\nOptional\nThe size of the car file.","type":"text"}]},"url":"https://api.filswan.com/my_miner/deals/{{deal_cid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deal\": {\n \"created_at\": \"1613398987\",\n \"deal_cid\": \"deal_cid\",\n \"file_path\": \"file_path\",\n \"file_source_url\": \"file_source_url\",\n \"id\": 1,\n \"md5_origin\": null,\n \"miner_id\": 1,\n \"note\": \"This is a test\",\n \"start_epoch\": 400300,\n \"status\": \"status\",\n \"task_id\": 1,\n \"updated_at\": \"1613398987\",\n \"user_id\": 18\n },\n \"message\": \"Deal updated successfully.\"\n },\n \"status\": \"Success\"\n}"}],"_postman_id":"9e355b41-1b3a-4670-a166-fe83cd563bed"},{"name":"Update deal status of a task","id":"8188f0d2-588a-4338-848d-c3cc852e2fd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"status","value":"{{status}}","type":"text","description":"String.\nRequired.\nThe new deal status.\nThe possible values are:
\nString.\nOptional.\nThe additional information you would like to provide regarding the deal.
\n"}]},"url":"https://api.filswan.com/my_miner/tasks/{{task_id}}/deals/{{deal_cid}}","urlObject":{"protocol":"https","path":["my_miner","tasks","{{task_id}}","deals","{{deal_cid}}"],"host":["api","filswan","com"],"query":[],"variable":[]}},"response":[{"id":"8a5d92cb-9599-4da1-97e5-1835669e6c1e","name":"Update deal status of a task","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"status","value":"{{status}}","type":"text","description":"String.\nRequired.\nThe new deal status.\nThe possible values are:\n- FileImporting. The car file is being imported by miner.\n- FileImported. The car file is successfully imported, and the deal is is being sealed.\n- DealActive. The deal is sealed successfully. Deal details can be found on blockchain.\n- ImportFailed. The car file is failed to be imported, or the deal is failed to be sealed."},{"key":"note","value":"{{note}}","type":"text","description":"String.\nOptional.\nThe additional information you would like to provide regarding the deal."}]},"url":"https://api.filswan.com/my_miner/tasks/{{task_id}}/deals/{{deal_cid}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deal\": {\n \"created_at\": \"1613398987\",\n \"deal_cid\": \"deal_cid\",\n \"file_path\": \"file_path\",\n \"file_source_url\": \"file_source_url\",\n \"md5_origin\": \"md5_origin\",\n \"miner_id\": 1,\n \"note\": \"note\",\n \"start_epoch\": 400000,\n \"status\": \"new-status\",\n \"task_id\": 1,\n \"updated_at\": \"1613398987\"\n },\n \"message\": \"Status new-status updated successfully.\"\n },\n \"status\": \"success\"\n}"}],"_postman_id":"8188f0d2-588a-4338-848d-c3cc852e2fd7"}],"id":"73fb3af6-a6af-40b0-b944-aa95f38aeca4","_postman_id":"73fb3af6-a6af-40b0-b944-aa95f38aeca4","description":""}],"id":"eb7af2f0-b112-4d3a-89ce-93202c512eb5","description":"These endpoints return details about tasks specified by the requested IDs.
\n","_postman_id":"eb7af2f0-b112-4d3a-89ce-93202c512eb5"}]}