Search
Preparing search index...
The search index is not available
ts-crypto-cli
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"hitbtc/api_clients/private_api_request"
External module "hitbtc/api_clients/private_api_request"
Index
Variables
debug
default
Client
Functions
create
HitBTCPrivate
Api
Client
hitbtc
Private
Api
Request
update
HitBTCDefault
Client
Variables
debug
debug
:
Debugger
Let
default
Client
default
Client
:
AxiosInstance
= createHitBTCPrivateApiClient()
Functions
Const
create
HitBTCPrivate
Api
Client
create
HitBTCPrivate
Api
Client
(
apikey
?:
string
, apiSecret
?:
string
)
:
AxiosInstance
Parameters
Default value
apikey:
string
= process.env.HITBTC_API_KEY || ''
Default value
apiSecret:
string
= process.env.HITBTC_API_SECRET || ''
Returns
AxiosInstance
Const
hitbtc
Private
Api
Request
hitbtc
Private
Api
Request
(
__namedParameters
:
{
data
:
any
;
method
:
"get"
|
"GET"
|
"delete"
|
"DELETE"
|
"head"
|
"HEAD"
|
"options"
|
"OPTIONS"
|
"post"
|
"POST"
|
"put"
|
"PUT"
|
"patch"
|
"PATCH"
|
"link"
|
"LINK"
|
"unlink"
|
"UNLINK"
;
params
:
any
;
url
:
string
}
)
:
Promise
<
any
>
Parameters
__namedParameters:
{
data
:
any
;
method
:
"get"
|
"GET"
|
"delete"
|
"DELETE"
|
"head"
|
"HEAD"
|
"options"
|
"OPTIONS"
|
"post"
|
"POST"
|
"put"
|
"PUT"
|
"patch"
|
"PATCH"
|
"link"
|
"LINK"
|
"unlink"
|
"UNLINK"
;
params
:
any
;
url
:
string
}
data
:
any
method
:
"get"
|
"GET"
|
"delete"
|
"DELETE"
|
"head"
|
"HEAD"
|
"options"
|
"OPTIONS"
|
"post"
|
"POST"
|
"put"
|
"PUT"
|
"patch"
|
"PATCH"
|
"link"
|
"LINK"
|
"unlink"
|
"UNLINK"
params
:
any
url
:
string
Returns
Promise
<
any
>
Const
update
HitBTCDefault
Client
update
HitBTCDefault
Client
(
apikey
:
string
, apiSecret
:
string
)
:
void
Parameters
apikey:
string
apiSecret:
string
Returns
void
Globals
"hitbtc/api_
clients/private_
api_
request"
debug
default
Client
create
HitBTCPrivate
Api
Client
hitbtc
Private
Api
Request
update
HitBTCDefault
Client
Generated using
TypeDoc