Circulating Supply

Circulating supply provides information on the Filecoin Network’s protocol token circulating supply and its breakdown.

FIL Protocol Circulating Supply

Description

The total amount and the change of FIL tokens in circulation according to the Protocol’s definition.

Request URL

GET: /circulating_supply/circulating_supply

Request Parameters

Variable	Type	Description	Example	Default
start_date	STRING	Start date of the selected period (Optional).	2022-07-01	The most recent date that the API includes.
end_date	STRING	End date of the selected period (Optional).	2022-07-01	The most recent date that the API includes.

note

The difference between end_date and start_date should be smaller than 90 days.

Request Examples

Code

Python

import requests

url = "https://api.spacescope.io/v2/circulating_supply/circulating_supply?end_date=2022-07-01&start_date=2022-07-01"

payload={}
headers = {
  'authorization': 'Bearer <--Please replace your API key here-->'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

GO

package main
import (
  "fmt"
  "net/http"
  "io/ioutil"
)
func main() {
  url := "https://api.spacescope.io/v2/circulating_supply/circulating_supply?end_date=2022-07-01&start_date=2022-07-01"
  method := "GET"
  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)
  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("authorization", "Bearer <--Please replace your API key here-->")
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.spacescope.io/v2/circulating_supply/circulating_supply?end_date=2022-07-01&start_date=2022-07-01',
  'headers': {
    'authorization': 'Bearer <--Please replace your API key here-->'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

cURL

curl --location --request GET 'https://api.spacescope.io/v2/circulating_supply/circulating_supply?end_date=2022-07-01&start_date=2022-07-01' \
--header 'authorization: Bearer <--Please replace your API key here-->'

Response Schema

Variable	Type	Description
stat_date	DATE	Refers to the date the data was recorded.
circulating_fil	NUMERIC	The amount of FIL circulating and tradeable in the economy.
mined_fil	NUMERIC	The amount of FIL that has been mined by storage miners.
vested_fil	NUMERIC	Total amount of FIL that is vested from genesis allocation.
reserve_disbursed_fil	NUMERIC	The amount of FIL that has been disbursed from the mining reserve.
locked_fil	NUMERIC	The amount of FIL locked as part of initial pledge, deal pledge, locked rewards, and other locking mechanisms.
burnt_fil	NUMERIC	The amount of FIL burned as part of on-chain computations and penalties.

Response Example

Response

{
   "request_id": "4e14a4aa-2368-4029-a660-5a883c0c29f1#666",
   "code": 0,
   "message": "success.",
   "data": [
       {
           "stat_date": "2022-07-01T00:00:00Z",
           "circulating_fil": 316590544.83518726,
           "mined_fil": 198962164.329669,
           "vested_fil": 267759227.86305127,
           "reserve_disbursed_fil": 17066618.96177341,
           "locked_fil": 136018723.96866196,
           "burnt_fil": 31178742.350644458
       }
   ]
}

---

Locked FIL Breakdown

Description

The breakdown of FIL tokens locked on the Filecoin Network.

Request URL

GET: /circulating_supply/network_locked_fil_breakdown

Request Parameters

Variable	Type	Description	Example	Default
start_date	STRING	Start date of the selected period (Optional).	2022-07-01	The most recent date that the API includes.
end_date	STRING	End date of the selected period (Optional).	2022-07-01	The most recent date that the API includes.

note

The difference between end_date and start_date should be smaller than 90 days.

Request Examples

Code

Python

import requests

url = "https://api.spacescope.io/v2/circulating_supply/network_locked_fil_breakdown?end_date=2022-07-01&start_date=2022-07-01"

payload={}
headers = {
  'authorization': 'Bearer <--Please replace your API key here-->'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

GO

package main
import (
  "fmt"
  "net/http"
  "io/ioutil"
)
func main() {
  url := "https://api.spacescope.io/v2/circulating_supply/network_locked_fil_breakdown?end_date=2022-07-01&start_date=2022-07-01"
  method := "GET"
  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)
  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("authorization", "Bearer <--Please replace your API key here-->")
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.spacescope.io/v2/circulating_supply/network_locked_fil_breakdown?end_date=2022-07-01&start_date=2022-07-01',
  'headers': {
    'authorization': 'Bearer <--Please replace your API key here-->'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

cURL

curl --location --request GET 'https://api.spacescope.io/v2/circulating_supply/network_locked_fil_breakdown?end_date=2022-07-01&start_date=2022-07-01' \
--header 'authorization: Bearer <--Please replace your API key here-->'

Response Schema

Variable	Type	Description
stat_date	DATE	Refers to the date the data was recorded.
total_initial_pledge	NUMERIC	The total active initial pledge on the Filecoin Network.
total_locked_funds	NUMERIC	The total active locked funds on the Filecoin Network.
new_initial_pledge	NUMERIC	The number of new initial pledges to the Filecoin Network in the last 24 hours.
new_reward_locked	NUMERIC	The number of new rewards locked in the Filecoin Network in the last 24 hours.
new_reward_released	NUMERIC	The new locked rewards less the increase in total locked funds in the last 24 hours.
sp_deal_collateral_change	NUMERIC	The change in deal collateral committed by storage providers in the last 24 hours.

Response Example

Response

{
   "request_id": "4e14a4aa-2368-4029-a660-5a883c0c29f1#666",
   "code": 0,
   "message": "success.",
   "data": [
       {
           "stat_date": "2022-07-01T00:00:00Z",
           "total_initial_pledge": 115655615.67550927,
           "total_locked_funds": 20338541.578073677,
           "new_initial_pledge": 104187.91617693826,
           "new_reward_locked": 217603.8203024527,
           "new_reward_released": 227465.61821696066,
           "sp_deal_collateral_change": 5863.12853187416
       }
   ]
}