#BIP-0171 - Enumerating supported currency-pair tokens ## HTTP://api.cerise.tech/ A common interface for requesting currency exchange rate information from a server - BIP171 implementation [**Contact the developer**](mailto:stephane.traumat@gmail.com) **Version** 0.2 [**Terms of Service**](https://github.com/straumat/cerise/blob/master/LICENSE) [**BSD 2-Clause &quot;Simplified&quot; License**](https://github.com/straumat/cerise/blob/master/LICENSE) # APIs ## / ### GET <a id="getSupportedCurrencyPairTokens">Enumerating supported currency-pair tokens</a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>mode</th> <td>query</td> <td>yes</td> <td>Always &quot;list&quot; for this request.</td> <td> - </td> <td>string </td> </tr> <tr> <th>quote</th> <td>query</td> <td>no</td> <td>If provided, the server MAY limit the results to only currency-pairs describing a currency with the given currency code(s).</td> <td> - </td> <td>Array[string] (multi)</td> </tr> <tr> <th>base</th> <td>query</td> <td>no</td> <td>If provided, the server MAY limit the results to only currency-pairs describing currency rates compared to the given currency code(s).</td> <td> - </td> <td>Array[string] (multi)</td> </tr> <tr> <th>locale</th> <td>query</td> <td>no</td> <td>If provided, the server MAY limit the results to only currency-pairs supporting the given Unicode CLDR locale(s).</td> <td> - </td> <td>Array[string] (multi)</td> </tr> </table> #### Response | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | Array[<a href="#/definitions/SupportedCurrencyPairTokensResult">SupportedCurrencyPairTokensResult</a>]| # Definitions ## <a name="/definitions/SupportedCurrencyPairTokensResult">SupportedCurrencyPairTokensResult</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>cp</td> <td> string </td> <td>required</td> <td>The currency-pair token. Currency-pair tokens are arbitrary Strings no longer than 255 characters, which may include any ASCII RFC 3986 unreserved characters (ie, alphanumerics and the hyphen, underscore, period, and tilde symbols)</td> <td>XBTUSD-ver4</td> </tr> <tr> <td>quote</td> <td> string </td> <td>required</td> <td>The currency code for the quote currency</td> <td>USD</td> </tr> <tr> <td>base</td> <td> string </td> <td>required</td> <td>The currency code for the base currency</td> <td>XBT</td> </tr> <tr> <td>locale</td> <td> string </td> <td>optional</td> <td>If provided, a String with the applicable Unicode CLDR locale</td> <td>en_US</td> </tr> <tr> <td>desc</td> <td> string </td> <td>optional</td> <td>Optional description. For example, it could be "Based on Florida BTM prices." or any other short String that provides information useful to the user</td> <td>Smoothed averages</td> </tr> <tr> <td>signature</td> <td> string </td> <td>optional</td> <td>May be used for Linked Data Signatures</td> <td></td> </tr> </table>