Search
Preparing search index...
The search index is not available
coinbase-pro-node-api
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
coinbase-pro-node-api
PublicClient
Class PublicClient
Hierarchy
FetchClient
<
unknown
>
PublicClient
AuthenticatedClient
Index
Constructors
constructor
Properties
#api_
url
#private
#product_
id
Accessors
api
Uri
fetch
Options
product_
id
Methods
delete
fetch
get
get24hr
Stats
get
Currencies
get
Currency
get
Historic
Rates
get
Order
Book
get
Product
get
Products
get
Ticker
get
Time
get
Trades
head
options
patch
post
put
trace
#parseJSON
Constructors
constructor
new
Public
Client
(
__namedParameters
?:
PublicClientOptions
)
:
PublicClient
Parameters
__namedParameters:
PublicClientOptions
= {}
Returns
PublicClient
Properties
Private
Readonly
#api_
url
#api_
url
:
URL
Private
#private
#private
:
any
Private
Readonly
#product_
id
#product_
id
:
string
Accessors
api
Uri
get
apiUri
(
)
:
URL
Returns
URL
fetch
Options
get
fetchOptions
(
)
:
RequestInit
set
fetchOptions
(
options
:
RequestInit
)
:
void
Returns
RequestInit
Parameters
options:
RequestInit
Returns
void
product_
id
get
product_id
(
)
:
string
Returns
string
Methods
delete
delete
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
fetch
fetch
(
path
:
string
, options
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
path:
string
options:
RequestInit
= {}
Returns
Promise
<
unknown
>
get
get
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
get24hr
Stats
get24hr
Stats
(
__namedParameters
?:
ProductID
)
:
Promise
<
ProductStats
>
Parameters
__namedParameters:
ProductID
= {}
Returns
Promise
<
ProductStats
>
get
Currencies
get
Currencies
(
)
:
Promise
<
CurrencyInfo
[]
>
Returns
Promise
<
CurrencyInfo
[]
>
get
Currency
get
Currency
(
__namedParameters
:
{
id
:
string
}
)
:
Promise
<
CurrencyInfo
>
Parameters
__namedParameters:
{
id
:
string
}
id
:
string
Returns
Promise
<
CurrencyInfo
>
get
Historic
Rates
get
Historic
Rates
(
__namedParameters
:
HistoricRatesArgs
)
:
Promise
<
Candle
[]
>
Parameters
__namedParameters:
HistoricRatesArgs
Returns
Promise
<
Candle
[]
>
get
Order
Book
get
Order
Book
(
__namedParameters
?:
OrderBookArgs
)
:
Promise
<
OrderBook
>
Parameters
__namedParameters:
OrderBookArgs
= {}
Returns
Promise
<
OrderBook
>
get
Product
get
Product
(
__namedParameters
?:
ProductID
)
:
Promise
<
ProductInfo
>
Parameters
__namedParameters:
ProductID
= {}
Returns
Promise
<
ProductInfo
>
get
Products
get
Products
(
)
:
Promise
<
ProductInfo
[]
>
Returns
Promise
<
ProductInfo
[]
>
get
Ticker
get
Ticker
(
__namedParameters
?:
ProductID
)
:
Promise
<
Ticker
>
Parameters
__namedParameters:
ProductID
= {}
Returns
Promise
<
Ticker
>
get
Time
get
Time
(
)
:
Promise
<
Time
>
Returns
Promise
<
Time
>
get
Trades
get
Trades
(
__namedParameters
?:
PagProductID
)
:
Promise
<
Trade
[]
>
Parameters
__namedParameters:
PagProductID
= {}
Returns
Promise
<
Trade
[]
>
head
head
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
options
options
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
patch
patch
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
post
post
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
put
put
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
trace
trace
(
path
?:
string
, _fetchOptions
?:
RequestInit
)
:
Promise
<
unknown
>
Parameters
Optional
path:
string
Optional
_fetchOptions:
RequestInit
Returns
Promise
<
unknown
>
Static
Private
#parseJSON
#parseJSON
(
string
:
string
)
:
unknown
Parameters
string:
string
Returns
unknown
Exports
Public
Client
constructor
#api_
url
#private
#product_
id
api
Uri
fetch
Options
product_
id
delete
fetch
get
get24hr
Stats
get
Currencies
get
Currency
get
Historic
Rates
get
Order
Book
get
Product
get
Products
get
Ticker
get
Time
get
Trades
head
options
patch
post
put
trace
#parseJSON