Sha256: bde590b1d3a89ce7d1d262d87510520a2925b52041ee03b42841c6bcdcb673df

Contents?: true

Size: 1.74 KB

Versions: 9

Compression:

Stored size: 1.74 KB

Contents

# CybridApiBank::SymbolsBankApi

All URIs are relative to *https://bank.sandbox.cybrid.app*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**list_symbols**](SymbolsBankApi.md#list_symbols) | **GET** /api/symbols | Get Symbols list |


## list_symbols

> Array<String> list_symbols

Get Symbols list

Retrieves a listing of symbols.Required scope: **prices:read**

### Examples

```ruby
require 'time'
require 'cybrid_api_bank_ruby'
# setup authorization
CybridApiBank.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiBank::SymbolsBankApi.new

begin
  # Get Symbols list
  result = api_instance.list_symbols
  p result
rescue CybridApiBank::ApiError => e
  puts "Error when calling SymbolsBankApi->list_symbols: #{e}"
end
```

#### Using the list_symbols_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(Array&lt;String&gt;, Integer, Hash)> list_symbols_with_http_info

```ruby
begin
  # Get Symbols list
  data, status_code, headers = api_instance.list_symbols_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Array&lt;String&gt;
rescue CybridApiBank::ApiError => e
  puts "Error when calling SymbolsBankApi->list_symbols_with_http_info: #{e}"
end
```

### Parameters

This endpoint does not need any parameter.

### Return type

**Array&lt;String&gt;**

### Authorization

[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
cybrid_api_bank_ruby-0.123.149 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.148 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.147 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.145 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.144 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.143 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.142 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.140 docs/SymbolsBankApi.md
cybrid_api_bank_ruby-0.123.139 docs/SymbolsBankApi.md