Volume.cc API

Note: All calls made to our api return a status code from the set {OK, NOK}. Our api is organised around REST and it returns JSON-encoded responses. The base URL of our API is:

http://api.volume.cc/query?!=METHOD
The following table contains a list of parameters and possible values. These appear in the API responses.

calc...real time status of the global calculator (status code)
calc_digest...real time hash digest of the current calculator variant
descriptor...string (name/id) of the current item expressed
status...indicates if the query executed successfully (status code)
time...the time that the query completed
volume...numeric volume metric, always expressed via cubic millimeters

Check Service Status

You may check the status of our service using the method service_status:

http://api.volume.cc/query?!=service_status
... returns the status of platform services.

Typical response of the form:

{"status":"OK","time":1704147358,"calc":"OK","calc_digest":"cb459c30854ef6dcc00af83a4381d1e8fb8dc97ffbdd6066a7710f859f3e7c57d1e0289452ab57355155c948fb8afabf97eab161b3907e2c7bd435980a98a28b"}

Fetch Volume of Network Share

Our api allows you to fetch the volume of a network share. The volume has already been computed for you according to our standards. In order to retrieve the network share volume, you need to pass a legitimate network share ID along with your GET request.

Use the method fetch_volume:

http://api.volume.cc/query?!=fetch_volume&id=1
... returns a volume for the network share 1.

Typical response of the form:

{"status":"OK","time":1704148911,"descriptor":"Tyre Estimate","volume":9351474.132185612}
Here the volume is always expressed via the cubic millimeter. In this case, it illustrates that the Tyre Estimate is one which has a spatial complexity of at least 9.3 litres.

Network Shares

Contact /\ Cookies /\ Privacy Policy /\ Terms of Use

VOLUME.CC © 2024