#BIP-0171 - Enumerating supported currency-pair tokens [**Contact the developer**](mailto:contact@cerise.tech) **Version** 0.5-SNAPSHOT ## / ### 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 | Everything worked as expected. | Array[<a href="#/definitions/SupportedCurrencyPairTokensResult">SupportedCurrencyPairTokensResult</a>]| | 400 | The request was unacceptable, often due to missing a required parameter. | <a href="#/definitions/CeriseError">CeriseError</a>| | 401 | No valid authorization was provided. | <a href="#/definitions/CeriseError">CeriseError</a>| | 402 | The parameters were valid but the request failed. | <a href="#/definitions/CeriseError">CeriseError</a>| | 404 | The requested resource doesn&#x27;t exist. | <a href="#/definitions/CeriseError">CeriseError</a>| | 500 | Something went wrong on the server. | <a href="#/definitions/CeriseError">CeriseError</a>| # Definitions ## <a name="/definitions/CeriseError">CeriseError</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>The type of error returned. One of api_connection_error, api_error, authentication_error, invalid_request_error or rate_limit_error.</td> <td>invalid_request_error</td> </tr> <tr> <td>message</td> <td> string </td> <td>required</td> <td>A human-readable message providing more details about the error.</td> <td>Invalid request to currency-pair information</td> </tr> <tr> <td>errors</td> <td> array[<a href="#/definitions/CeriseErrorDetail">CeriseErrorDetail</a>] </td> <td>optional</td> <td>List of errors.</td> <td></td> </tr> </table> ## <a name="/definitions/CeriseErrorDetail">CeriseErrorDetail</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>code</td> <td> string </td> <td>required</td> <td>Error code.</td> <td>currency_code_invalid</td> </tr> <tr> <td>message</td> <td> string </td> <td>required</td> <td>A human-readable message providing more details about the error.</td> <td>Invalid currency code : AAA</td> </tr> </table> ## <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>