Demonstrate scenarios

GET https://api.coindesk.com/v1/bpi/currentprice.json

Good documentation is more than just API reference. It includes user scenarios to show what is possible with the API. Guide new users through the proper sequence of API calls to accomplish a specific workflow [using variables to pass along data] These use cases can be grouped in folders or as a stand-alone collection.

Once you receive a response from the API server, you can parse that information and store it as a variable to be used for later. Take a look under the Tests tab. Or check out this detailed example of [chaining requests] from this step-by-step tutorial.

 

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key

Datatype

Required

Description

RESPONSES

status OK

{"time":{"updated":"Oct 19, 2020 18:21:00 UTC","updatedISO":"2020-10-19T18:21:00+00:00","updateduk":"Oct 19, 2020 at 19:21 BST"},"disclaimer":"This data was produced from the CoinDesk Bitcoin Price Index (USD). Non-USD currency data converted using hourly conversion rate from openexchangerates.org","chartName":"Bitcoin","bpi":{"USD":{"code":"USD","symbol":"$","rate":"11,753.5700","description":"United States Dollar","rate_float":11753.57},"GBP":{"code":"GBP","symbol":"£","rate":"9,065.5285","description":"British Pound Sterling","rate_float":9065.5285},"EUR":{"code":"EUR","symbol":"€","rate":"9,977.1119","description":"Euro","rate_float":9977.1119}}}