May
JUN
Jul
04
2021
2022
2023
About this capture
T h e W a y b a c k M a c h i n e - h t t p : / / w e b . a r c h i v e . o r g / w e b / 2 0 2 2 0 6 0 4 1 1 1 9 4 4 / h t t p s : / / b i t t r e x . g i t h u b . i o / a p i / v 3
A P I R e f e r e n c e
v 1 . 1 v 3
v 3
● v 1 . 1 E O L ● v 3
H o w - T o G u i d e : U p g r a d i n g t o v 3
×
T o p i c s
I n t r o d u c t i o n C h a n g e L o g U p c o m i n g B r e a k i n g C h a n g e s K n o w n I s s u e s R E S T A P I O v e r v i e w ●
C a l l L i m i t s ●
A u t h e n t i c a t i o n ●
P a g i n a t i o n ●
P l a c i n g O r d e r s ●
P l a c i n g C o n d i t i o n a l O r d e r s ●
E r r o r C o d e s
●
E x a m p l e S o c k e t C l i e n t s ●
C o n n e c t i n g ●
A u t h e n t i c a t i n g ●
S u b s c r i b i n g ●
H a n d l i n g M e s s a g e s ●
S y n c h r o n i z i n g ●
U n s u b s c r i b i n g
S u b a c c o u n t s
R e s t A P I
●
G E T / a c c o u n t ●
G E T / a c c o u n t / f e e s / f i a t ●
G E T / a c c o u n t / f e e s / f i a t / { c u r r e n c y S y m b o l } ●
G E T / a c c o u n t / f e e s / t r a d i n g ●
G E T / a c c o u n t / f e e s / t r a d i n g / { m a r k e t S y m b o l } ●
G E T / a c c o u n t / v o l u m e ●
G E T / a c c o u n t / p e r m i s s i o n s / m a r k e t s ●
G E T / a c c o u n t / p e r m i s s i o n s / m a r k e t s / { m a r k e t S y m b o l } ●
G E T / a c c o u n t / p e r m i s s i o n s / c u r r e n c i e s ●
G E T / a c c o u n t / p e r m i s s i o n s / c u r r e n c i e s / { c u r r e n c y S y m b o l }
●
G E T / a d d r e s s e s ●
P O S T / a d d r e s s e s ●
G E T / a d d r e s s e s / { c u r r e n c y S y m b o l }
●
G E T / b a l a n c e s ●
H E A D / b a l a n c e s ●
G E T / b a l a n c e s / { c u r r e n c y S y m b o l }
●
P O S T / b a t c h
●
G E T / c o n d i t i o n a l - o r d e r s / { c o n d i t i o n a l O r d e r I d } ●
D E L E T E / c o n d i t i o n a l - o r d e r s / { c o n d i t i o n a l O r d e r I d } ●
G E T / c o n d i t i o n a l - o r d e r s / c l o s e d ●
G E T / c o n d i t i o n a l - o r d e r s / o p e n ●
H E A D / c o n d i t i o n a l - o r d e r s / o p e n ●
P O S T / c o n d i t i o n a l - o r d e r s
●
G E T / c u r r e n c i e s ●
G E T / c u r r e n c i e s / { s y m b o l }
●
G E T / d e p o s i t s / o p e n ●
H E A D / d e p o s i t s / o p e n ●
G E T / d e p o s i t s / c l o s e d ●
G E T / d e p o s i t s / B y T x I d / { t x I d } ●
G E T / d e p o s i t s / { d e p o s i t I d }
●
G E T / e x e c u t i o n s / { e x e c u t i o n I d } ●
G E T / e x e c u t i o n s ●
G E T / e x e c u t i o n s / l a s t - i d ●
H E A D / e x e c u t i o n s / l a s t - i d
●
G E T / f u n d s - t r a n s f e r - m e t h o d s / { f u n d s T r a n s f e r M e t h o d I d }
●
G E T / m a r k e t s ●
G E T / m a r k e t s / s u m m a r i e s ●
H E A D / m a r k e t s / s u m m a r i e s ●
G E T / m a r k e t s / t i c k e r s ●
H E A D / m a r k e t s / t i c k e r s ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / t i c k e r ●
G E T / m a r k e t s / { m a r k e t S y m b o l } ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / s u m m a r y ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / o r d e r b o o k ●
H E A D / m a r k e t s / { m a r k e t S y m b o l } / o r d e r b o o k ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / t r a d e s ●
H E A D / m a r k e t s / { m a r k e t S y m b o l } / t r a d e ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / r e c e n t ●
H E A D / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / r e c e n t ●
G E T / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / h i s t o r i c a l / { y e a r } / { m o n t h } / { d a y }
●
G E T / o r d e r s / c l o s e d ●
G E T / o r d e r s / o p e n ●
D E L E T E / o r d e r s / o p e n ●
H E A D / o r d e r s / o p e n ●
G E T / o r d e r s / { o r d e r I d } ●
D E L E T E / o r d e r s / { o r d e r I d } ●
G E T / o r d e r s / { o r d e r I d } / e x e c u t i o n s ●
P O S T / o r d e r s
●
G E T / p i n g
●
G E T / s u b a c c o u n t s ●
P O S T / s u b a c c o u n t s ●
G E T / s u b a c c o u n t s / { s u b a c c o u n t I d } ●
G E T / s u b a c c o u n t s / w i t h d r a w a l s / o p e n ●
G E T / s u b a c c o u n t s / w i t h d r a w a l s / c l o s e d ●
G E T / s u b a c c o u n t s / d e p o s i t s / o p e n ●
G E T / s u b a c c o u n t s / d e p o s i t s / c l o s e d
●
G E T / t r a n s f e r s / s e n t ●
G E T / t r a n s f e r s / r e c e i v e d ●
G E T / t r a n s f e r s / { t r a n s f e r I d } ●
P O S T / t r a n s f e r s
●
G E T / w i t h d r a w a l s / o p e n ●
G E T / w i t h d r a w a l s / c l o s e d ●
G E T / w i t h d r a w a l s / B y T x I d / { t x I d } ●
G E T / w i t h d r a w a l s / { w i t h d r a w a l I d } ●
D E L E T E / w i t h d r a w a l s / { w i t h d r a w a l I d } ●
P O S T / w i t h d r a w a l s ●
G E T / w i t h d r a w a l s / a l l o w e d - a d d r e s s e s W e b s o c k e t A P I
A u t h e n t i c a t e I s A u t h e n t i c a t e d S u b s c r i b e U n s u b s c r i b e W e b s o c k e t S t r e a m s
B a l a n c e C a n d l e C o n d i t i o n a l O r d e r D e p o s i t E x e c u t i o n H e a r t b e a t M a r k e t S u m m a r i e s M a r k e t S u m m a r y O r d e r O r d e r b o o k T i c k e r s T i c k e r T r a d e S c h e m a D e f i n i t i o n s
A c c o u n t C o m m i s s i o n R a t e s W i t h M a r k e t F i a t T r a n s a c t i o n F e e A c c o u n t V o l u m e M a r k e t P o l i c y C u r r e n c y P o l i c y D e p o s i t M e t h o d s W i t h d r a w M e t h o d s A d d r e s s N e w A d d r e s s B a l a n c e B a t c h O p e r a t i o n B a t c h R e s p o n s e C o n d i t i o n a l O r d e r N e w O r d e r N e w C a n c e l C o n d i t i o n a l O r d e r P a g i n a t i o n P a r a m e t e r s D a t e F i l t e r N e w C o n d i t i o n a l O r d e r C u r r e n c y D e p o s i t E r r o r E x e c u t i o n E x e c u t i o n L a s t I d F u n d s T r a n s f e r M e t h o d M a r k e t M a r k e t S u m m a r y T i c k e r O r d e r B o o k O r d e r B o o k E n t r y T r a d e C a n d l e O r d e r B u l k C a n c e l R e s u l t S e r v i c e P i n g S u b a c c o u n t N e w S u b a c c o u n t W i t h d r a w a l S e n t T r a n s f e r I n f o R e c e i v e d T r a n s f e r I n f o N e w T r a n s f e r N e w W i t h d r a w a l A l l o w e d A d d r e s s D e l e t e O r d e r S o c k e t R e s p o n s e B i t t r e x A P I
A P I R e f e r e n c e B i t t r e x p r o v i d e s a s i m p l e a n d p o w e r f u l A P I c o n s i s t i n g o f R E S T e n d p o i n t s f o r t r a n s a c t i o n a l o p e r a t i o n s a n d a c o m p l e m e n t a r y W e b s o c k e t s e r v i c e p r o v i d i n g s t r e a m i n g m a r k e t a n d u s e r d a t a u p d a t e s . A c c e s s t o a n d u s e o f t h e A P I i s g o v e r n e d b y o u r T e r m s o f S e r v i c e . I f y o u a r e a u s e r o f B i t t r e x . c o m , t h e a p p l i c a b l e T e r m s o f S e r v i c e a r e a v a i l a b l e
h e r e . I f y o u a r e a u s e r o f B i t t r e x G l o b a l , t h e a p p l i c a b l e T e r m s o f S e r v i c e a r e a v a i l a b l e
h e r e . I f y o u h a v e a n y A P I q u e s t i o n s , f e e d b a c k , o r r e c o m m e n d a t i o n s p l e a s e p o s t a q u e s t i o n v i a o u r
G i t h u b p a g e .
A P I E n d p o i n t
https://api.bittrex.com/v3
S c h e m e s :
h t t p s V e r s i o n :
v 3 C h a n g e L o g
0 2 / 0 3 / 2 0 2 2
● N o t e t o a n y o n e s t i l l u s i n g t h e o l d v 1 . 1 A P I : t h e
v 1 . 1 A P I w i l l b e s h u t d o w n o n 3 / 3 / 2 0 2 2 . P l e a s e
u p g r a d e t o t h e v 3 A P I b e f o r e t h a t d a t e .
0 1 / 1 9 / 2 0 2 2
● W e w i l l s o o n b e g i n c h a r g i n g f e e s o n U S D w i r e t r a n s f e r w i t h d r a w a l s . A n e w
G E T / a c c o u n t / f e e s / f i a t e n d p o i n t h a s b e e n a d d e d t o r e t r i e v e d e t a i l s o f f i a t t r a n s f e r f e e s . O n c e t h e f e e i s i n p l a c e i t w i l l b e v i s i b l e t h e r e ( i f t h e r e a r e n o f e e s i t w i l l r e t u r n a n e m p t y a r r a y ) . T h e r e i s a l s o i n f o r m a t i o n a b o u t w i r e t r a n s f e r a n d f e e s a v a i l a b l e o n Z e n d e s k f o r
US a n d
G l o b a l u s e r s .
0 9 / 2 9 / 2 0 2 1
● S u m m a r y i n f o r m a t i o n i s n o w a v a i l a b l e a b o u t t h e b a n k a c c o u n t
( f u n d s t r a n s f e r m e t h o d ) a s s o c i a t e d w i t h a f i a t
w i t h d r a w a l . ● Y o u c a n n o w i n i t i a t e w i r e t r a n s f e r
w i t h d r a w a l s f r o m t h e A P I ● C r e a t i n g n e w d e p o s i t a d d r e s s e s n o l o n g e r r e q u i r e s w i t h d r a w a l p e r m i s s i o n s ● T h e r e a r e n o w m o r e o p t i o n s f o r q u e r y i n g s u b a c c o u n t d e p o s i t s a n d w i t h d r a w a l s
T o s e e o l d e r c h a n g e s , p l e a s e v i s i t t h e
h i s t o r y p a g e .
U p c o m i n g B r e a k i n g C h a n g e s N o f u r t h e r b r e a k i n g c h a n g e s a r e p l a n n e d
K n o w n I s s u e s R e f e r t o t h e
G i t H u b i s s u e s p a g e R E S T A P I O v e r v i e w T h i s s e c t i o n p r o v i d e s a n o v e r v i e w o f k e y c o n c e p t s t o u n d e r s t a n d w h e n w o r k i n g w i t h t h e B i t t r e x v 3 R E S T A P I . K e e p i n m i n d t h e f o l l o w i n g : ● E n a b l e 2 F A o n y o u r a c c o u n t . A P I K e y s c a n n o t b e g e n e r a t e d u n l e s s 2 F A i s e n a b l e d a n d e x t e n d e d v e r i f i c a t i o n i s d o n e o n t h e a c c o u n t . ● A l l R E S T r e q u e s t s m u s t b e s e n t t o h t t p s : / / a p i . b i t t r e x . c o m / v 3 u s i n g t h e a p p l i c a t i o n / j s o n c o n t e n t t y p e . N o n - H T T P S r e q u e s t s w i l l b e r e d i r e c t e d t o H T T P S , p o s s i b l y c a u s i n g f u n c t i o n a l o r p e r f o r m a n c e i s s u e s w i t h y o u r a p p l i c a t i o n .
C a l l L i m i t s T h e B i t t r e x A P I e m p l o y s c a l l l i m i t s o n a l l R E S T e n d p o i n t s t o e n s u r e t h e e f f i c i e n c y a n d a v a i l a b i l i t y o f t h e p l a t f o r m f o r a l l c u s t o m e r s . L i m i t s a r e s e t s u c h t h a t t h e y s h o u l d n o t i n t e r f e r e w i t h l e g i t i m a t e u s a g e p a t t e r n s . F r e q u e n t p o l l i n g f o r u p d a t e s o n m a r k e t d a t a , o r d e r s t a t u s , h i s t o r y , e t c . i s d i s c o u r a g e d a n d w i l l l i k e l y r e s u l t i n y o u r r e q u e s t s f a i l i n g w i t h a 4 2 9 s t a t u s c o d e . I f y o u n e e d f r e q u e n t u p d a t e s , s u b s c r i b e t o t h e w e b s o c k e t i n s t e a d o f p o l l i n g . F r i v o l o u s o r d e r p l a c e m e n t a n d c a n c e l l a t i o n i n a t i g h t l o o p w i t h l o w f i l l r a t e s i s a l s o d i s c o u r a g e d . T h r o t t l i n g i s t r a c k e d o n a m i n u t e b y m i n u t e b a s i s w i t h t h e l i m i t r e s e t t i n g a t t h e s t a r t o f t h e n e x t m i n u t e . I n g e n e r a l , m a k i n g a m a x i m u m o f 6 0 A P I c a l l s p e r m i n u t e s h o u l d b e s a f e , b u t h i g h e r r e q u e s t r a t e s a r e a l l o w e d d e p e n d i n g o n t h e u s a g e p a t t e r n . I f y o u r e c e i v e a t h r o t t l i n g e r r o r , b a c k o f f f o r t h e r e m a i n d e r o f t h e m i n u t e a n d r e d u c e t h e r a t e o f s u b s e q u e n t r e q u e s t s . A d d i t i o n a l i n f o r m a t i o n a n d h e l p o n t h i s t o p i c a r e a v a i l a b l e f o r c o r p o r a t e a n d h i g h - v o l u m e c u s t o m e r s v i a t h e i r a c c o u n t m a n a g e r s .
A u t h e n t i c a t i o n O v e r v i e w I n o r d e r t o p r o p e r l y s i g n a n a u t h e n t i c a t e d r e q u e s t f o r t h e B i t t r e x v 3 A P I , t h e f o l l o w i n g h e a d e r s m u s t b e i n c l u d e d : A p i - K e y
A p i - T i m e s t a m p
A p i - C o n t e n t - H a s h
A p i - S i g n a t u r e
A p i - S u b a c c o u n t - I d ( o p t i o n a l )
T h e f o l l o w i n g s e c t i o n s a r e i n s t r u c t i o n s f o r p r o p e r l y p o p u l a t i n g t h e s e h e a d e r s . A p i - K e y P o p u l a t e t h i s h e a d e r w i t h y o u r A P I k e y . E x a m p l e V a l u e : 4 8 9 4 x x x x x x x x 4 0 7 e 8 2 7 d 0 5 x x x x x x x x x x A p i - T i m e s t a m p P o p u l a t e t h i s h e a d e r w i t h t h e c u r r e n t t i m e a s a U N I X t i m e s t a m p , i n e p o c h - m i l l i s e c o n d f o r m a t . S a m p l e J S C o d e S n i p p e t : var timestamp = new Date ().getTime();
E x a m p l e V a l u e : 1 5 4 2 3 2 3 4 5 0 0 1 6 A p i - C o n t e n t - H a s h P o p u l a t e t h i s h e a d e r w i t h a S H A 5 1 2 h a s h o f t h e r e q u e s t b o d y , H e x - e n c o d e d . I f t h e r e i s n o r e q u e s t b o d y , p o p u l a t e t h i s h e a d e r w i t h a S H A 5 1 2 h a s h o f a n e m p t y s t r i n g . S a m p l e J S C o d e S n i p p e t : var contentHash = CryptoJS.SHA512(JSON .stringify(requestBody)).toString(CryptoJS.enc.Hex);
E x a m p l e V a l u e : cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e
T h i s i s t h e c o r r e c t v a l u e o f t h e c o n t e n t h a s h f o r a n y r e q u e s t w i t h n o b o d y . A p i - S u b a c c o u n t - I d ( O n l y f o r s u b a c c o u n t f e a t u r e ) ( N O T E : T h i s f u n c t i o n a l i t y i s l i m i t e d t o p a r t n e r s a n d u n a v a i l a b l e t o g e n e r a l t r a d e r s . ) I f y o u w i s h t o m a k e a r e q u e s t o n b e h a l f o f a s u b a c c o u n t , y o u w i l l n e e d t o : (一) A u t h e n t i c a t e u s i n g a l l 4 o f t h e h e a d e r s a b o v e r e f e r r i n g t o y o u r m a s t e r a c c o u n t . (二) P o p u l a t e t h e A p i - S u b a c c o u n t - I d h e a d e r w i t h t h e U U I D o f t h e s u b a c c o u n t y o u w i s h t o i m p e r s o n a t e f o r t h i s r e q u e s t . T h e s p e c i f i e d s u b a c c o u n t
m u s t b e a s u b a c c o u n t o f t h e m a s t e r a c c o u n t u s e d t o a u t h e n t i c a t e t h e r e q u e s t . (三) I n c l u d e t h e A p i - S u b a c c o u n t - I d h e a d e r a t t h e e n d o f t h e p r e - s i g n e d s i g n a t u r e , a s i n d i c a t e d i n t h e n e x t s e c t i o n .
E x a m p l e V a l u e : x 1 1 1 x 1 1 x - 8 9 6 8 - 4 8 a c - b 9 5 6 - x 1 x 1 1 x 1 1 1 1 1 1 A p i - S i g n a t u r e C r e a t e a p r e - s i g n s t r i n g f o r m e d f r o m t h e f o l l o w i n g i t e m s a n d c o n c a t e n a t i n g t h e m t o g e t h e r : (一) C o n t e n t s o f y o u r A p i - T i m e s t a m p h e a d e r (二) T h e f u l l U R I y o u a r e u s i n g t o m a k e t h e r e q u e s t ( i n c l u d i n g q u e r y s t r i n g ) (三) T h e H T T P m e t h o d o f t h e r e q u e s t , i n a l l c a p s ( G E T , P O S T , D E L E T E , e t c . ) (四) C o n t e n t s o f y o u r A p i - C o n t e n t - H a s h h e a d e r (五) C o n t e n t o f y o u r A p i - S u b a c c o u n t - I d h e a d e r ( o r a n e m p t y s t r i n g i f n o t p r e s e n t ) O n c e y o u h a v e c r e a t e d t h i s p r e - s i g n s t r i n g , s i g n i t v i a H m a c S H A 5 1 2 , u s i n g y o u r A P I s e c r e t a s t h e s i g n i n g s e c r e t . H e x - e n c o d e t h e r e s u l t o f t h i s o p e r a t i o n a n d p o p u l a t e t h e A p i - S i g n a t u r e h e a d e r w i t h i t . S a m p l e J S C o d e S n i p p e t : var uri = 'https://api.bittrex.com/v3/balances' ;
var preSign = [timestamp, uri, method, contentHash, subaccountId].join('' );
var signature = CryptoJS.HmacSHA512(preSign, apiSecret).toString(CryptoJS.enc.Hex);
E x a m p l e P r e - S i g n e d V a l u e ( n o s u b a c c o u n t ) 1542323450016https://api.bittrex.com/v3/balancesGETcf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e
E x a m p l e P r e - S i g n e d V a l u e ( w i t h s u b a c c o u n t ) 1542323450016https://api.bittrex.com/v3/balancesGETcf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3ex111x11x-8968-48ac-b956-x1x11x111111
E x a m p l e P o s t - S i g n e d V a l u e : 939047623f0efbe10bfbb32f18e5d8885b2a91be3c3cea82adf0dd2d20892b20bcb6a10a91fec3afcedcc009f2b2a86c5366974cfadcf671fe0490582568f51f
O v e r v i e w S e v e r a l B i t t r e x A P I r e s o u r c e s s u p p o r t b u l k f e t c h e s v i a ' l i s t ' A P I m e t h o d s . F o r e x a m p l e , y o u c a n l i s t d e p o s i t s , l i s t c l o s e d o r d e r s , a n d l i s t w i t h d r a w a l s . T h e s e l i s t A P I m e t h o d s s h a r e a c o m m o n s t r u c t u r e , u s i n g a t l e a s t t h e s e t h r e e p a r a m e t e r s : p a g e S i z e , n e x t P a g e T o k e n a n d p r e v i o u s P a g e T o k e n . T h e s e p a r a m e t e r s , i f n e c e s s a r y a r e s p e c i f i e d a s q u e r y p a r a m e t e r s o n t h e H T T P r e q u e s t . A r g u m e n t s :
p a g e S i z e ( o p t i o n a l ) : A l i m i t o n t h e n u m b e r o f o b j e c t s t o b e r e t u r n e d b e t w e e n 1 a n d 2 0 0 , d e f a u l t s t o 1 0 0
n e x t P a g e T o k e n ( o p t i o n a l ) : T h e i d o f t h e l a s t i t e m o n t h e c u r r e n t p a g e . T h i s i s u s e d f o r d e f i n i n g t h e s t a r t i n g p o i n t o f t h e n e x t p a g e . F o r i n s t a n c e , i f y o u m a k e a l i s t r e q u e s t a n d r e c e i v e 1 0 0 o b j e c t s e n d i n g w i t h o b j F o o , y o u r s u b s e q u e n t c a l l c a n i n c l u d e n e x t P a g e T o k e n = o b j F o o ' s i d i n o r d e r t o f e t c h t h e n e x t p a g e o f t h e l i s t s t a r t i n g a f t e r o b j F o o .
p r e v i o u s P a g e T o k e n ( o p t i o n a l ) : T h e i d o f t h e f i r s t i t e m o n t h e c u r r e n t p a g e . T h i s i s u s e d f o r d e f i n i n g t h e e n d i n g p o i n t o f t h e p r e v i o u s p a g e . F o r i n s t a n c e , i f y o u m a k e a l i s t r e q u e s t a n d r e c e i v e 1 0 0 o b j e c t s s t a r t i n g w i t h o b j B a r , y o u r s u b s e q u e n t c a l l c a n i n c l u d e p r e v i o u s P a g e T o k e n = o b j B a r ' s i d i n o r d e r t o f e t c h t h e p r e v i o u s p a g e o f t h e l i s t .
E x a m p l e s : L i s t w i t h d r a w a l s , i n r e v e r s e c h r o n o l o g i c a l o r d e r , u p t o m a x i m u m o f 2 0 w i t h d r a w a l s , s t a r t i n g a t t h e m o s t r e c e n t w i t h d r a w a l c r e a t e d : h t t p s : / / a p i . b i t t r e x . c o m / v 3 / w i t h d r a w a l s ? p a g e S i z e = 2 0 L i s t w i t h d r a w a l s , i n r e v e r s e c h r o n o l o g i c a l o r d e r , u p t o m a x i m u m o f 1 0 w i t h d r a w a l s , s t a r t i n g a f t e r t h e w i t h d r a w a l w i t h I D o f 9 4 0 a f 3 c 3 - 6 6 5 d - 4 4 3 2 - a 1 2 e - c d f 8 f d 9 9 a b 3 b h t t p s : / / a p i . b i t t r e x . c o m / v 3 / w i t h d r a w a l s ? p a g e S i z e = 1 0 & n e x t P a g e T o k e n = 9 4 0 a f 3 c 3 - 6 6 5 d - 4 4 3 2 - a 1 2 e - c d f 8 f d 9 9 a b 3 b L i s t w i t h d r a w a l s , i n r e v e r s e c h r o n o l o g i c a l o r d e r , u p t o a m a x i m u m o f 1 0 w i t h d r a w a l s , e n d i n g b e f o r e t h e w i t h d r a w a l w i t h I D o f 0 d 9 9 0 d d 2 - 4 1 0 3 - 4 d 5 7 - 8 e 8 0 - 0 4 7 e 8 8 6 5 3 7 d b : h t t p s : / / a p i . b i t t r e x . c o m / v 3 / w i t h d r a w a l s ? p a g e S i z e = 1 0 & p r e v i o u s P a g e T o k e n = 0 d 9 9 0 d d 2 - 4 1 0 3 - 4 d 5 7 - 8 e 8 0 - 0 4 7 e 8 8 6 5 3 7 d b
P l a c i n g O r d e r s O r d e r s a r e p l a c e d u s i n g t h e
P O S T / o r d e r s o p e r a t i o n . Y o u c a n f i n d s a m p l e r e q u e s t b o d i e s f o r d i f f e r e n t t y p e s o f o r d e r s i n t h e e x a m p l e s i n t h i s s e c t i o n .
O r d e r T y p e s
M a r k e t O r d e r : A n o r d e r t o b u y o r s e l l a s p e c i f i e d q u a n t i t y o f a n a s s e t i m m e d i a t e l y a t t h e b e s t a v a i l a b l e p r i c e . T h e m a r k e t o r d e r w i l l c o n s u m e a v a i l a b l e o r d e r s o n t h e b o o k a s i t e x e c u t e s . C o n s e q u e n t l y , e s p e c i a l l y f o r l a r g e o r d e r s , t h e a v e r a g e p r i c e a t w h i c h t h e o r d e r i s f i l l e d w i l l d e v i a t e f r o m t h e l a s t - t r a d e d p r i c e o r c u r r e n t q u o t e .
L i m i t O r d e r : A n o r d e r t o t r a d e a s p e c i f i e d q u a n t i t y o f a n a s s e t a t a s p e c i f i e d p r i c e . A b u y o r d e r w i l l o n l y b e f i l l e d a t o r b e l o w t h e l i m i t p r i c e a n d a s e l l o r d e r w i l l o n l y b e f i l l e d a t o r a b o v e t h e l i m i t p r i c e .
C e i l i n g O r d e r : A m a r k e t o r l i m i t o r d e r t h a t a l l o w s y o u t o s p e c i f y t h e a m o u n t o f q u o t e c u r r e n c y y o u w a n t t o s p e n d ( o r r e c e i v e , i f s e l l i n g ) i n s t e a d o f t h e q u a n t i t y o f t h e m a r k e t c u r r e n c y ( e . g . b u y $ 1 0 0 U S D o f B T C a t t h e c u r r e n t m a r k e t B T C p r i c e )
G o o d - T i l - C a n c e l l e d O r d e r : T h e o r d e r r e m a i n s i n f o r c e u n t i l i t i s e x p l i c i t l y c a n c e l l e d e i t h e r b y t h e u s e r o r b y B i t t r e x
I m m e d i a t e - O r - C a n c e l O r d e r : T h e o r d e r w i l l b e f i l l e d i m m e d i a t e l y a s m u c h a s p o s s i b l e a n d t h e n c a n c e l l e d .
F i l l - o r - K i l l : T h e o r d e r w i l l b e f i l l e d i m m e d i a t e l y a n d c o m p l e t e l y , o r i t i s c a n c e l l e d w i t h o u t b e i n g f i l l e d a t a l l .
P o s t O n l y : T h i s o p t i o n a l l o w s m a r k e t m a k e r s t o e n s u r e t h a t t h e i r o r d e r s a r e m a k i n g i t t o t h e o r d e r b o o k i n s t e a d o f m a t c h i n g w i t h a p r e - e x i s t i n g o r d e r . N o t e : I f t h e o r d e r i s n o t a m a k e r o r d e r , y o u w i l l r e t u r n a n e r r o r a n d t h e o r d e r w i l l b e c a n c e l l e d
C o n d i t i o n a l O r d e r : A d i r e c t i v e f o r t h e s y s t e m t o p l a c e a n o r d e r o n y o u r b e h a l f w h e n t h e p r i c e o n t h e m a r k e t m o v e s p a s t a g i v e n t h r e s h o l d . T h e s e a r e t r e a t e d s e p a r a t e l y f r o m o r d e r s . R e f e r t o t h e P l a c i n g C o n d i t i o n a l O r d e r s s e c t i o n f o r m o r e i n f o r m a t i o n .
O r d e r t y p e s a n d t i m e i n f o r c e
T h e f o l l o w i n g t a b l e s h o w s w h i c h t i m e i n f o r c e o p t i o n s a p p l y t o w h i c h o r d e r t y p e s .
timeInForce
LIMIT
MARKET
CEILING_LIMIT
CEILING_MARKET
GOOD_TIL_CANCELLED
BUY OR SELL
NOT ALLOWED
NOT ALLOWED
NOT ALLOWED
IMMEDIATE_OR_CANCEL
BUY OR SELL
BUY OR SELL
BUY OR SELL
BUY OR SELL
FILL_OR_KILL
BUY OR SELL
BUY OR SELL
BUY OR SELL
BUY OR SELL
POST_ONLY_GOOD_TIL_CANCELLED
BUY OR SELL
NOT ALLOWED
NOT ALLOWED
NOT ALLOWED
c l i e n t O r d e r I d
A n o p t i o n a l U U I D w h i c h i s g e n e r a t e d b y t h e u s e r t o t o k e e p a t r a c k o f t h e o r d e r . I f t h e o u t c o m e o f p l a c i n g a n o r d e r i s n o t k n o w n ( f o r e x a m p l e d u e t o a c l i e n t - s i d e c r a s h t h a t o c c u r r e d w h i l e p l a c i n g t h e o r d e r ) , t h e s a m e o r d e r c a n b e s a f e l y p l a c e d a g a i n u s i n g t h e s a m e U U I D a s t h e c l i e n t O r d e r I d . I f t h e o r d e r w a s r e c e i v e d a n d p r o c e s s e d t h e f i r s t t i m e , t h e A P I w i l l r e t u r n a n e r r o r t h a t i n c l u d e s t h e e x i s t i n g o r d e r ' s i d i n s t e a d o f c r e a t i n g a s e c o n d o r d e r . T h i s p r o t e c t i o n i s i n p l a c e f o r 2 4 h o u r s a f t e r a n o r d e r i s p l a c e d . A l t h o u g h c l i e n t O r d e r I d s w h i c h a r e m o r e t h a n 2 4 h o u r s o l d a r e n o l o n g e r c h e c k e d a g a i n s t n e w o r d e r s , t h e y r e m a i n a s s o c i a t e d w i t h t h e i r o r d e r s a s m e t a d a t a a n d m a y b e r e t r i e v e d b y c l i e n t s .
R e q u e s t B o d y E x a m p l e F o r L i m i t O r d e r
{"marketSymbol" : "string" ,"direction" : "string" ,"type" : "LIMIT" ,"quantity" : "number (double)" ,"limit" : "number (double)" ,"timeInForce" : "GOOD_TIL_CANCELLED || IMMEDIATE_OR_CANCEL || FILL_OR_KILL || POST_ONLY_GOOD_TIL_CANCELLED" ,"clientOrderId" : "string (uuid)"
R e q u e s t B o d y E x a m p l e F o r M a r k e t O r d e r
{"marketSymbol" : "string" ,"direction" : "string" ,"type" : "MARKET" ,"quantity" : "number (double)" ,"timeInForce" : "IMMEDIATE_OR_CANCEL || FILL_OR_KILL" ,"clientOrderId" : "string (uuid)"
R e q u e s t B o d y E x a m p l e F o r C e i l i n g l i m i t O r d e r
{"marketSymbol" : "string" ,"direction" : "string" ,"type" : "CEILING_LIMIT" ,"limit" : "number (double)" ,"ceiling" : "number (double)" ,"timeInForce" : "IMMEDIATE_OR_CANCEL || FILL_OR_KILL" ,"clientOrderId" : "string (uuid)"
R e q u e s t B o d y E x a m p l e F o r C e i l i n g M a r k e t O r d e r
{"marketSymbol" : "string" ,"direction" : "string" ,"type" : "CEILING_MARKET" ,"ceiling" : "number (double)" ,"timeInForce" : "IMMEDIATE_OR_CANCEL||FILL_OR_KILL" ,"clientOrderId" : "string (uuid)"
P l a c i n g C o n d i t i o n a l O r d e r s P l a c i n g C o n d i t i o n a l O r d e r s C o n d i t i o n a l o r d e r s a r e p l a c e d u s i n g t h i s A P I b y s p e c i f y i n g t h e m a r k e t p r i c e t r i g g e r c o n d i t i o n s a n d w h a t a c t i o n t o t a k e w h e n t h e t r i g g e r i s r e a c h e d . W h e n a t r a d e o c c u r s o n t h e m a r k e t t h a t m a t c h e s t h e t r i g g e r c o n d i t i o n s , t h e a c t i o n s a r e t r i g g e r e d s u c h a s p l a c i n g a n o r d e r . C o n d i t i o n a l o r d e r s a r e n o t t h e s a m e a s o r d e r s . T h e y a r e s t o r e d s e p a r a t e l y f r o m n o r m a l o r d e r s a n d d o n o t a p p e a r o n t h e o r d e r b o o k . A s s u c h , t h e r e i s a s m a l l d e l a y b e t w e e n t r a d i n g o c c u r r i n g o n t h e m a r k e t a n d c o r r e s p o n d i n g c o n d i t i o n a l o r d e r s b e i n g t r i g g e r e d . C a r e m u s t a l s o b e t a k e n w h e n w o r k i n g w i t h c o n d i t i o n a l o r d e r s b e c a u s e b a l a n c e i s n o t r e s e r v e d . I f y o u c r e a t e a c o n d i t i o n a l o r d e r c o s t i n g a n a m o u n t i n e x c e s s o f y o u r a c c o u n t b a l a n c e f o r a c u r r e n c y o r i f y o u r a c c o u n t b a l a n c e d r o p s d u e t o o t h e r t r a d e s s u b s e q u e n t t o y o u p l a c i n g a c o n d i t i o n a l o r d e r t h e r e i s a r i s k t h a t y o u w i l l n o t h a v e e n o u g h b a l a n c e a v a i l a b l e t o p l a c e t h e o r d e r w h e n t h e c o n d i t i o n a l o r d e r ’ s c o n d i t i o n i s m e t . I f t h i s o c c u r s , p l a c e m e n t o f t h e o r d e r w i l l f a i l . T r i g g e r c o n d i t i o n s T h e t r i g g e r f o r a c o n d i t i o n a l o r d e r i s m a d e u p o f t w o p a r t s : t h e o p e r a n d a n d t h e t r i g g e r p r i c e o r p e r c e n t a g e . O p e r a n d m a y b e e i t h e r l e s s t h a n o r e q u a l t o ( L T E ) o r g r e a t e r t h a n o r e q u a l t o ( G T E ) . t r i g g e r P r i c e w i l l b e c o m p a r e d t o t h e p r i c e o f t h e l a s t t r a d e o n t h e m a r k e t t o d e t e r m i n e i f t h e a c t i o n ( s ) s p e c i f i e d i n t h e c o n d i t i o n a l o r d e r s h o u l d b e e x e c u t e d . A l t e r n a t e l y , a t r a i l i n g S t o p P e r c e n t m a y b e s p e c i f i e d . T h i s w i l l c a u s e t h e t r i g g e r P r i c e t o f l o a t a f i x e d p e r c e n t o f f f r o m t h e s m a l l e s t o r l a r g e s t p r i c e s e e n s i n c e t h e c o n d i t i o n a l o r d e r w a s p l a c e d . T h e b e l o w t a b l e s u m m a r i z e s t h e s e o p t i o n s :
Parameter provided
Operand
Trigger Price
Triggers when
triggerPrice
LTE
Constant
A trade occurs at a price LTE the provided trigger price
triggerPrice
GTE
Constant
A trade occurs at a price GTE the provided trigger price
trailingStopPercent
LTE
Calculated to be trailingStopPercent less than the maximum trade price on the market since the conditional order was placed
A trade occurs at a price LTE the calculated trigger price
trailingStopPercent
GTE
Calculated to be trailingStopPercent more than the minimum trade price on the market since the conditional order was placed
A trade occurs at a price GTE the calculated trigger price
A c t i o n s W h e n t h e t r i g g e r c o n d i t i o n i s m e t , t h i s w i l l r e s u l t i n a n e w o r d e r b e i n g p l a c e d a n d , o p t i o n a l l y , a n o t h e r o r d e r o r c o n d i t i o n a l o r d e r b e i n g c a n c e l l e d . T h e o r d e r t o p l a c e i s c o n f i g u r e d b y p o p u l a t i n g o r d e r T o C r e a t e w i t h t h e s a m e o b j e c t y o u w o u l d p o s t t o c r e a t e a n o r d e r . T h e r e a r e s o m e l i m i t a t i o n s : p o s t o n l y o r d e r s , a w a r d s , a n d c l i e n t O r d e r I d a r e n o t s u p p o r t e d . F o r i d e m p o t e n c y , i n s t e a d s p e c i f y a c l i e n t C o n d i t i o n a l O r d e r I d a s a p e e r o f o r d e r T o C r e a t e i n t h e r e q u e s t b o d y . I f c a n c e l i n g a n o r d e r i s d e s i r e d , p r o v i d e t h e i d o f t h e o r d e r t o c a n c e l a n d t h e t y p e o f o r d e r ( O R D E R f o r a n o r d e r o n t h e b o o k o r C O N D I T I O N A L _ O R D E R ) i n t h e o r d e r T o C a n c e l o b j e c t . T h i s w i l l p a i r t h e n e w l y p l a c e d o r w i t h i t s t a r g e t . I f e i t h e r c o n d i t i o n a l o r d e r t r i g g e r s , t h e o t h e r w i l l b e c a n c e l l e d . I f b o t h a r e t r i g g e r s i m u l t a n e o u s l y , o n l y t h e f i r s t c o n d i t i o n a l o r d e r p l a c e w i l l t r i g g e r a n d t h e o t h e r w i l l b e c a n c e l l e d . N o t e t h a t t h e r e i s n o t c u r r e n t l y a w a y t o b r e a k u p t w o c o n d i t i o n a l o r d e r s p a i r e d i n t h e f a s h i o n . T o c h a n g e t h e c a n c e l l a t i o n r e l a t i o n s h i p , b o t h c o n d i t i o n a l o r d e r s m u s t b e c a n c e l l e d a n d p l a c e d a g a i n . Y o u c a n n o t l i n k m o r e t h a n t w o o r d e r s i n t h e f a s h i o n . A l s o n o t e t h a t i f t h e o r d e r T o C a n c e l i s a n o r d e r o n t h e b o o k a n d t h e c o n d i t i o n a l o r d e r t r i g g e r s , t h e o r d e r o n t h e b o o k w i l l b e c a n c e l l e d t o f r e e u p f u n d s p r i o r t o a t t e m p t i n g t o p l a c e t h e o r d e r e d t r i g g e r e d b y t h e c o n d i t i o n . C o m m o n U s e C a s e s T h i s s e c t i o n d e s c r i b e s s o m e c o m m o n u s e c a s e s a n d p r o v i d e s i n s t r u c t i o n f o r h o w t o m e e t t h e m u s i n g t h e A P I :
S t o p O r d e r : A m a r k e t o r d e r t r i g g e r e d b y p r i c e m o v i n g p a s t a g i v e n t h r e s h o l d . S p e c i f y o p e r a n d a n d t r i g g e r P r i c e a s d e s i r e d a n d d e f i n e a m a r k e t b u y o r s e l l o r d e r i n o r d e r T o C r e a t e .
S t o p L i m i t O r d e r : A l i m i t o r d e r t r i g g e r e d b y p r i c e m o v i n g p a s t a g i v e n t h r e s h o l d . S p e c i f y o p e r a n d a n d t r i g g e r P r i c e a s d e s i r e d a n d d e f i n e a l i m i t b u y o r s e l l o r d e r i n o r d e r T o C r e a t e .
S t o p L o s s O r d e r : A m a r k e t s e l l o r d e r t r i g g e r e d b y p r i c e f a l l i n g t o a g i v e n t h r e s h o l d . S p e c i f y L T E a s t h e o p e r a n d a n d t r i g g e r P r i c e a s d e s i r e d a n d d e f i n e a m a r k e t s e l l o r d e r i n o r d e r T o C r e a t e .
T a k e P r o f i t O r d e r : A l i m i t s e l l o r d e r t r i g g e r e d b y p r i c e r i s i n g t o a g i v e n t h r e s h o l d . S p e c i f y G T E a s t h e o p e r a n d a n d t r i g g e r P r i c e a s d e s i r e d a n d d e f i n e a l i m i t s e l l o r d e r i n o r d e r T o C r e a t e .
T r a i l i n g S t o p L o s s O r d e r : A m a r k e t s e l l o r d e r t r i g g e r e d w h e n p r i c e f a l l s m o r e t h a n a g i v e n a m o u n t b e l o w t h e h i g h e s t p r i c e s e e n s i n c e t h e o r d e r w a s c r e a t e d . S p e c i f y L T E a s t h e o p e r a n d , s e t t r a i l i n g S t o p P e r c e n t a s d e s i r e d , a n d d e f i n e a m a r k e t s e l l o r d e r i n o r d e r T o C r e a t e .
O n e C a n c e l s t h e O t h e r O r d e r ( O C O ) : A p a i r o f o r d e r s w h e r e i f o n e i s t r i g g e r e d ( f o r a c o n d i t i o n a l o r d e r ) o r e x e c u t e d ( f o r a n o r d e r o n b o o k ) t h e o t h e r i s a u t o m a t i c a l l y c a n c e l l e d . W h e n c r e a t i n g t h e s e c o n d o r d e r i n t h e p a i r , s p e c i f y t h e i d o f t h e f i r s t o r d e r i n o r d e r T o C a n c e l . N o t e t h a t c u r r e n t l y o n e m e m b e r o f t h e O C O p a i r m u s t b e a c o n d i t i o n a l o r d e r .
N o t e t h a t m o r e c o m b i n a t i o n s a r e p o s s i b l e . T h e s e e x a m p l e s a r e i n t e n d e d a s a g u i d e t o s o m e c o m m o n u s e c a s e s , n o t a n e x h a u s t i v e l i s t o f s u p p o r t e d s c e n a r i o s .
E r r o r C o d e s
O v e r v i e w :
I f a n e r r o r o c c u r s d u r i n g t h e p r o c e s s i n g o f a n A P I r e q u e s t , t h e B i t t r e x A P I w i l l r e t u r n a n e r r o r t o t h e c a l l e r . T h e g e n e r a l f l o w o f i n f o r m a t i o n t o c h e c k i s : s t a t u s c o d e o f t h e r e s p o n s e .
e r r o r c o d e a n d o t h e r i n f o r m a t i o n i n t h e r e s p o n s e b o d y ( J S O N )
H T T P S t a t u s C o d e s
Status Code
Description
400 - Bad Request
The request was malformed, often due to a missing or invalid parameter. See the error code and response data for more details.
401 - Unauthorized
The request failed to authenticate (example: a valid api key was not included in your request header)
403 - Forbidden
The provided api key is not authorized to perform the requested operation (example: attempting to trade with an api key not authorized to make trades)
404 - Not Found
The requested resource does not exist.
409 - Conflict
The request parameters were valid but the request failed due to an operational error. (example: INSUFFICIENT_FUNDS)
429 - Too Many Requests
Too many requests hit the API too quickly. Please make sure to implement exponential backoff with your requests.
501 - Not Implemented
The service requested has not yet been implemented.
503 - Service Unavailable
The request parameters were valid but the request failed because the resource is temporarily unavailable (example: CURRENCY_OFFLINE)
E r r o r C o d e s
T h i s s e c t i o n l i s t s s o m e c o m m o n e r r o r c o d e s t h a t a r e r e t u r n e d b y t h e A P I , b u t i s n o t a n e x h a u s t i v e l i s t . I f y o u h a v e q u e s t i o n s a b o u t a n e r r o r c o d e y o u a r e r e c e i v i n g , f e e l f r e e t o p o s t a n i s s u e o n G i t H u b .
Error Code
Description
ACCOUNT_DISABLED
This account is disabled
APIKEY_INVALID
The Api-Key request header is missing or invalid
CLIENTORDERID_ALREADY_EXISTS
The value specified for clientOrderId has already been used. The corresponding Bittrex id for the order will be included in the response.
CLIENTWITHDRAWALID_ALREADY_EXISTS
The value specified for clientWithdrawalId has already been used. The corresponding Bittrex id for the withdrawal will be included in the response.
CRYPTO_ADDRESS_ALREADY_EXISTS
A deposit address already exists for the currency which the user is attempting to create an address
CURRENCY_DOES_NOT_EXIST
The currency symbol provided does not correspond to a currency
CURRENCY_OFFLINE
The currency is offline
DUST_TRADE_DISALLOWED_MIN_VALUE
The amount of quote currency involved in a transaction would be less than the minimum limit of 10K satoshis
FILL_OR_KILL
The order was submitted with the fill_or_kill time in force and could not be filled completely so it was cancelled
INSUFFICIENT_AWARDS
The order was placed with useAwards: true but the user did not have sufficient balance of BTXCRD to cover commission
INSUFFICIENT_FUNDS
The user is trying to buy or sell more currency than they can afford or currently hold, respectively
INVALID_MARKET_ORDER
A market order was requested in the order type, but other options selected which conflict with that (e.g. GOOD_TIL_CANCELLED time in force)
INVALID_NEXT_PAGE_TOKEN
The specified value for nextPageToken doesn't correspond to an item in the list
INVALID_ORDER_TYPE
The selected order type conflicts with other options specified on the order (e.g. setting a limit price for a market order)
INVALID_PREVIOUS_PAGE_TOKEN
The specified value for previousPageToken doesn't correspond to an item in the list
INVALID_RESTRICTED_ACCOUNT
The user is a Bittrex US user attempting an action on a Bittrex Global only currency or market
INVALID_SIGNATURE
The Api-Signature request header is missing or invalid
MARKET_DOES_NOT_EXIST
The market symbol provided does not correspond to a market
MARKET_NAME_REVERSED
Market symbols in v3 are in base-quote order whereas in v1 it was the reverse. This error occures when we think a market symbol was sent to v3 in quote-base order.
MARKET_OFFLINE
Te market is offline
MAX_ORDERS_ALLOWED
The user already has the maximum allowed open orders and cannot open another until one is closed
MIN_TRADE_REQUIREMENT_NOT_MET
The trade was smaller than the min trade size quantity for the market
NOT_ALLOWED
This account is not allowed to perform this action
ORDER_DOES_NOT_EXIST
The specified orderId does not correspond to an order, or corresponds to an order that is no longer available in the API such as an order that was cancelled with no fills
ORDER_ERROR_CONTACT_SUPPORT
Operation could not be completed due to an internal error
ORDER_NOT_OPEN
Tried to cancel an order that was not open
ORDER_TYPE_INVALID
The order creation request is malformed in some way
ORDERBOOK_DEPTH
If allowed to execute, the order would have been executed at least in part at a price in excess of what is allowed by the price slippage limit on the market
POST_ONLY
The order was submitted as 'post only' but matched with an order already on the book and thus was cancelled
RATE_PRECISION_NOT_ALLOWED
The limit price specified includes more precision than is allowed on this market
REQUESTID_ALREADY_EXISTS
The value specified for requestId has already been used. The corresponding Bittrx id for the request will be included in the response.
SELF_TRADE
The order matched with an order on the book placed by the same user
SOURCE_OF_FUNDS_REQUIRED
The user has not yet provided the required basic source of funds information. May be resolved by logging into the website and filling out the form when prompted.
SUBACCOUNT_OF_SUBACCOUNT_NOT_ALLOWED
Attempted to create a subaccout of a subaccount
THROTTLED
Too many requests have been made
WITHDRAWAL_TOO_SMALL
The size of the requested withdrawal is not large enough. Withdrawals must be greater than three times the size of the currency's txFee.
WHITELIST_VIOLATION_WITHDRAWAL_ADDRESS
Attempting to withdrawal to an address that is either not on the users list of allowed withdrawal address or which is still within the wait period
W e b s o c k e t O v e r v i e w T h e v 3 w e b s o c k e t i s i n t e n d e d t o a l l o w a c l i e n t t o s u b s c r i b e t o a l i v e s t r e a m o f u p d a t e s a b o u t t h i n g s t h a t a r e c h a n g i n g i n t h e s y s t e m i n s t e a d o f n e e d i n g t o p o l l t h e R E S T A P I l o o k i n g f o r u p d a t e s . I t i s d e s i g n e d t o c o m p l e m e n t a n d b e u s e d i n c o n j u n c t i o n w i t h t h e v 3 R E S T A P I . A s s u c h t h e m e s s a g e s s e n t f r o m t h e s o c k e t i n c l u d e p a y l o a d s t h a t a r e f o r m a t t e d t o m a t c h t h e c o r r e s p o n d i n g d a t a m o d e l s f r o m t h e v 3 R E S T A P I . L i k e t h e e x i s t i n g v 1 s o c k e t , t h e v 3 s o c k e t i s b a s e d o n
M i c r o s o f t A S P . n e t ’ s S i g n a l R . W e a r e n o t u s i n g A S P . n e t C o r e ’ s S i g n a l R i m p l e m e n t a t i o n a t t h i s t i m e . A s s u c h , a n y e x i s t i n g S i g n a l R c l i e n t i m p l e m e n t a t i o n w o r k i n g w i t h t h e v 1 s o c k e t s h o u l d b e a b l e t o b e m o d i f i e d t o w o r k w i t h t h e n e w v 3 s o c k e t . I f w o r k i n g i n t h e . N e t e n v i r o n m e n t , t h e M i c r o s o f t . A s p N e t . S i g n a l R . C l i e n t N u G e t p a c k a g e i s t h e r e c o m m e n d e d b a s i s f o r a c l i e n t i m p l e m e n t a t i o n . T h e c o d e s n i p p e t s i n t h e r e m a i n d e r o f t h i s s e c t i o n a s s u m e y o u a r e w o r k i n g i n C # u s i n g t h a t l i b r a r y . R e f e r t o t h e
E x a m p l e S o c k e t C l i e n t s s e c t i o n f o r e x a m p l e s i n o t h e r l a n g u a g e s .
E x a m p l e S o c k e t C l i e n t s T h i s s e c t i o n i n c l u d e s s i m p l e e x a m p l e s o f h o w t o s u b s c r i b e a n d r e c e i v e m e s s a g e s i n a f e w p o p u l a r l a n g u a g e s . A l l o f t h e s e e x a m p l e s f o l l o w t h e s a m e b a s i c p a t t e r n . T h e y w i l l c o n n e c t t o t h e s o c k e t s e r v e r , a u t h e n t i c a t e i f a n A P I k e y a n d s e c r e t a r e p r o v i d e d , a t t e m p t t o s u b s c r i b e t o a f e w s t r e a m s , a n d f i n a l l y p r i n t m e s s a g e s r e c e i v e d o n t h o s e s t r e a m s t o c o n s o l e . ● C # :
V 3 W e b s o c k e t E x a m p l e . c s ● J a v a :
V 3 W e b s o c k e t E x a m p l e . j a v a ● N o d e . j s :
V 3 W e b s o c k e t E x a m p l e . j s ● P y t h o n :
V 3 W e b s o c k e t E x a m p l e . p y C o n n e c t i n g T o c o n n e c t t o t h e v 3 s o c k e t , c r e a t e a H u b C o n n e c t i o n t o t h e s o c k e t U R L (
h t t p s : / / s o c k e t - v 3 . b i t t r e x . c o m / s i g n a l r ) a n d c r e a t e a h u b p r o x y . T h e h u b n a m e t o u s e w h e n c r e a t i n g t h e p r o x y i s " c 3 " . O n c e t h e s e o b j e c t s a r e c r e a t e d , y o u c a n s t a r t t h e H u b C o n n e c t i o n t o c o n n e c t t o t h e s o c k e t . T h e r e a r e n o s t r e a m s o f d a t a s e n t a u t o m a t i c a l l y b a s e d s o l e l y o n b e i n g c o n n e c t e d . T o g e t d a t a , y o u m u s t
s u b s c r i b e t o o n e o r m o r e s t r e a m s . T h e a v a i l a b l e s t r e a m s a r e d i s c u s s e d i n t h e W e b s o c k e t S t r e a m s s e c t i o n o f t h i s s i t e .
public class SocketClient private string _url;private HubConnection _hubConnection;private IHubProxy _hubProxy;public SocketClient (string urlnew HubConnection(_url);"c3" );public async Task<bool > Connect (await _hubConnection.Start();return _hubConnection.State == ConnectionState.Connected;
A u t h e n t i c a t i n g S o m e s t r e a m s c o n t a i n p r i v a t e d a t a a n d r e q u i r e t h a t y o u b e a u t h e n t i c a t e d p r i o r t o s u b s c r i b i n g . I n o r d e r t o a u t h e n t i c a t e , i n v o k e t h e A u t h e n t i c a t e m e t h o d o n t h e h u b a s s h o w n i n t h e e x a m p l e . T h e a u t h e n t i c a t i o n w i l l n e e d t o b e r e n e w e d p e r i o d i c a l l y . C u r r e n t l y a u t h e n t i c a t i o n l a s t s f o r 1 0 m i n u t e s . W h e n a u t h e n t i c a t i o n e x p i r e s s u b s c r i p t i o n s t o a n y p r i v a t e s t r e a m s w i l l b e c a n c e l l e d . O n e m i n u t e p r i o r t o a u t h e n t i c a t i o n e x p i r i n g , a r e m i n d e r m e s s a g e w i l l b e s e n t n o t i f y i n g t h e c l i e n t t h a t i t i s t i m e t o r e a u t h e n t i c a t e .
public async Task<SocketResponse> Authenticate (string apiKey, string apiKeySecretvar timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();var randomContent = $"{ Guid.NewGuid() } " ;var content = string .Join("" , timestamp, randomContent);var signedContent = CreateSignature(apiKeySecret, content);var result = await _hubProxy.Invoke<SocketResponse>("Authenticate" , return result;public void SetAuthExpiringHandler (string apiKey, string apiKeySecret"authenticationExpiring" , async () =>await Authenticate(apiKey, apiKeySecret);private static string CreateSignature (string apiSecret, string datavar hmacSha512 = new HMACSHA512(Encoding.ASCII.GetBytes(apiSecret));var hash = hmacSha512.ComputeHash(Encoding.ASCII.GetBytes(data));return BitConverter.ToString(hash).Replace("-" , string .Empty);
S u b s c r i b i n g T o s u b s c r i b e t o o n e o r m o r e s t r e a m s , s i m p l y i n v o k e t h e S u b s c r i b e m e t h o d w i t h a n a r r a y o f s t r e a m s t o w h i c h y o u w i s h t o s u b s c r i b e . F o r a l i s t o f s t r e a m n a m e s , r e f e r t o t h e W e b s o c k e t S t r e a m s s e c t i o n . T h e S u b s c r i b e m e t h o d m a y b e i n v o k e d a s m a n y t i m e s a s d e s i r e d i f n o t a l l d e s i r e d s t r e a m s a r e k n o w n i n i t i a l l y . T h e r e s u l t o f i n v o k i n g t h e S u b s c r i b e m e t h o d i s a l i s t o f
S o c k e t R e s p o n s e o b j e c t s c o n t a i n i n g a B o o l e a n v a l u e i n d i c a t i n g i f t h e s u b s c r i p t i o n w a s s u c c e s s f u l a n d , i n t h e c a s e o f f a i l u r e , a n e r r o r c o d e .
public async Task<List<SocketResponse>> Subscribe(string [] channels)
{
return await _hubProxy.Invoke<List<SocketResponse>>("Subscribe" , (object )channels);
}
H a n d l i n g M e s s a g e s O n c e y o u h a v e s u b s c r i b e d t o a s t r e a m , y o u w i l l b e g i n r e c e i v i n g m e s s a g e s a s r e l e v a n t a c t i v i t y o c c u r e s i n t h e s y s t e m . T h e i n c o m i n g m e s s a g e s m u s t b e d e c o d e d t o d o s o m e t h i n g w i t h t h e m . A b a s i c e x a m p l e o f t h i s i s s h o w n b e l o w . T h e " b a l a n c e " s p e c i f i e d a s a p a r a m e t e r i s t h e n a m e o f t h e m e s s a g e t o h a n d l e . T h i s c o r r e s p o n d s t o t h e n a m e o f t h e s t r e a m . F o r a l i s t o f p o s s i b l e v a l u e s a n d h o w t h e y m a p t o s t r e a m s , r e f e r t o t h e W e b s o c k e t S t r e a m s s e c t i o n . M e s s a g e s s e n t o n t h e v 3 s o c k e t a r e g z i p p e d a n d m u s t b e d e c o m p r e s s e d p r i o r t o b e i n g u s e d . T h e D a t a C o n v e r t e r . D e c o d e m e t h o d s h o w n i n t h e e x a m p l e i s d o i n g t h i s d e c o m p r e s s i o n a n d t h e n p a r s i n g t h e r e s u l t i n g j s o n i n t o a n o b j e c t . _hubProxy.On("balance" , message =>
{
var decoded = DataConverter.Decode<BalanceDelta>(message);
});
T h e s c h e m a f o r t h e B a l a n c e D e l t a t y p e c a n b e f o u n d i n t h e d o c u m e n t a t i o n f o r t h e
B a l a n c e s t r e a m . I t c o n s i s t s o f a n a c c o u n t I d f i e l d f o r i d e n t i f y i n g t h e a c c o u n t ( o r s u b a c c o u n t ) t h e m e s s a g e r e l a t e s t o , t h e s e q u e n c e n u m b e r o f t h e m e s s a g e u s e d f o r s y n c h r o n i z a t i o n , a n d t h e a c t u a l y d e l t a w h i c h i s a n u p d a t e d
B a l a n c e o b j e c t . T h e s c h e m a o f t h e o b j e c t d e l t a s s e n t b y t h e w e b s o c k a r e t h e s a m e a s t h o s e r e t r i v e d f r o m t h e e q u i v a l e n t R E S T A P I . F o r d e t a i l s a b o u t i n d i v i d u a l s t r e a m s , r e f e r t o t h e W e b s o c k e t S t r e a m s s e c t i o n o f t h i s p a g e .
public static class DataConverter private static JsonSerializerSettings _jsonSerializerSettings = new JsonSerializerSettingsnew CamelCasePropertyNamesContractResolver(),new List<JsonConverter>new StringEnumConverter(),public static T Decode<T>(string wireData)byte [] gzipData = Convert.FromBase64String(wireData);string json = null ;using (var decompressedStream = new MemoryStream())using (var compressedStream = new MemoryStream(gzipData))using (var deflateStream = new DeflateStream(compressedStream, CompressionMode.Decompress))0 ;using (var streamReader = new StreamReader(decompressedStream))return JsonConvert.DeserializeObject<T>(json, _jsonSerializerSettings);
S y n c h r o n i z i n g T o e n s u r e y o u h a v e t h e m o s t r e c e n t d a t a , a n d h a v e n o t m i s s e d a n y t h i n g , t h e r e c o m m e n d e d s e q u e n c e o f s t e p s i s t o : (一) S u b s c r i b e t o t h e r e l e v a n t s o c k e t s t r e a m s (二) B e g i n t o q u e u e u p m e s s a g e s w i t h o u t p r o c e s s i n g t h e m (三) C a l l t h e e q u i v a l e n t v 3 R E S T A P I a n d r e c o r d b o t h t h e r e s u l t s a n d t h e v a l u e o f t h e r e t u r n e d S e q u e n c e h e a d e r . R e f e r t o t h e d e s c r i p t i o n s o f i n d i v i d u a l s t r e a m s t o f i n d t h e c o r r e s p o n d i n g R E S T A P I . N o t e t h a t y o u m u s t c a l l t h e R E S T A P I w i t h t h e s a m e p a r a m e t e r s a s y o u u s e d t o s u b s c r i b e d t o t h e s t r e a m t o g e t t h e r i g h t s n a p s h o t . F o r e x a m p l e , o r d e r b o o k s n a p s h o t s o f d i f f e r e n t d e p t h s w i l l h a v e d i f f e r e n t s e q u e n c e n u m b e r s . (四) I f t h e S e q u e n c e h e a d e r i s l e s s t h a n t h e s e q u e n c e n u m b e r o f t h e f i r s t q u e u e d s o c k e t m e s s a g e r e c e i v e d ( u n l i k e l y ) , d i s c a r d t h e r e s u l t s o f s t e p 3 a n d t h e n r e p e a t s t e p 3 u n t i l t h i s c h e c k p a s s e s . (五) D i s c a r d a l l s o c k e t m e s s a g e s w h e r e t h e s e q u e n c e n u m b e r i s l e s s t h a n o r e q u a l t o t h e S e q u e n c e h e a d e r r e t r i e v e d f r o m t h e R E S T c a l l (六) A p p l y t h e r e m a i n i n g s o c k e t m e s s a g e s i n o r d e r o n t o p o f t h e r e s u l t s o f t h e R E S T c a l l . T h e o b j e c t s r e c e i v e d i n t h e s o c k e t d e l t a s h a v e t h e s a m e s c h e m a s a s t h e o b j e c t s r e t u r n e d b y t h e R E S T A P I . E a c h s o c k e t d e l t a i s a s n a p s h o t o f a n o b j e c t . T h e i d e n t i t y o f t h e o b j e c t i s d e f i n e d b y a u n i q u e k e y m a d e u p o f o n e o r m o r e f i e l d s i n t h e m e s s a g e ( s e e d o c u m e n t a t i o n o f i n d i v i d u a l s t r e a m s f o r d e t a i l s ) . T o a p p l y s o c k e t d e l t a s t o a l o c a l c a c h e o f d a t a , s i m p l y r e p l a c e t h e o b j e c t s i n t h e c a c h e w i t h t h o s e c o m i n g f r o m t h e s o c k e t w h e r e t h e k e y s m a t c h . (七) C o n t i n u e t o a p p l y m e s s a g e s a s t h e y a r e r e c e i v e d f r o m t h e s o c k e t a s l o n g a s s e q u e n c e n u m b e r o n t h e s t r e a m i s a l w a y s i n c r e a s i n g b y 1 e a c h m e s s a g e ( N o t e : f o r p r i v a t e s t r e a m s , t h e s e q u e n c e n u m b e r i s s c o p e d t o a s i n g l e a c c o u n t o r s u b a c c o u n t ) . (八) I f a m e s s a g e i s r e c e i v e d t h a t i s n o t t h e n e x t i n o r d e r , r e t u r n t o s t e p 2 i n t h i s p r o c e s s
F o r a p p l i c a t i o n s t h a t d e p e n d o n k e e p i n g t h e s t r e a m o f d a t a a s r e l i a b l e a s p o s s i b l e , c r e a t i n g m u l t i p l e s o c k e t c o n n e c t i o n s f o r r e d u n d a n c y i s r e c o m m e n d e d . T h e s e q u e n c e n u m b e r s p u b l i s h e d a c r o s s a l l o f t h e c o n n e c t i o n s w i l l b e c o n s i s t e n t w i t h e a c h o t h e r a n d c a n b e u s e d t o d e t e r m i n e w h i c h m e s s a g e s h a v e b e e n r e c e i v e d .
U n s u b s c r i b i n g U n s u b s c r i b i n g f r o m s t r e a m s f o l l o w s t h e s a m e p a t t e r n a s s u b s c r i b i n g t o s t r e a m s . S i m p l y i n v o k e t h e U n s u b s c r i b e m e t h o d o n t h e h u b a n d p r o v i d e t h e l i s t o f s t r e a m s y o u w i s h t o u n s u b s c r i b e f r o m .
public async Task<List<SocketResponse>> Unsubscribe(string [] channels)
{
return await _hubProxy.Invoke<List<SocketResponse>>("Unsubscribe" , (object )channels);
}
S u b a c c o u n t s ( N O T E : T h i s f u n c t i o n a l i t y i s l i m i t e d t o p a r t n e r s a n d u n a v a i l a b l e t o g e n e r a l t r a d e r s . ) S u b a c c o u n t s p r o v i d e a w a y f o r p a r t n e r s t o m o d e l t h e i r u s e r s w i t h o u t n e e d i n g t o c r e a t e i n d i v i d u a l u s e r a c c o u n t s . E a c h s u b a c c o u n t h a s i t s o w n d e p o s i t a d d r e s s e s , b a l a n c e s , d e s p o s i t s a n d w i t h d r a w a l s , o r d e r s , e t c . P a r t n e r s c o n t r o l a l l a c t i o n s o f t h e i r s u b a c c o u n t s v i a t h e v 3 R E S T A P I a n d m a y u s e t h e v 3 w e b s o c k e t t o b e n o t i f i e d o f a n y u p d a t e s t o t h e i r b a l a n c e s , d e p o s i t s , a n d o r d e r s . I n o r d e r t o w o r k w i t h s u b a c c o u n t s , y o u m u s t b e u s i n g a n A P I k e y t h a t h a s s u b a c c o u n t p e r m i s s i o n s . P a r t n e r s w h o a r e p a r t o f t h i s p r o g r a m c a n w o r k w i t h t h e i r B i t t r e x r e p r e s e n t a t i v e t o g e t t h e i r A P I k e y e n a b l e d . T o c r e a t e a s u b a c c o u n t , P O S T t o t h e
s u b a c c o u n t s e n d p o i n t . T h i s w i l l c r e a t e a n e w s u b a c c o u n t a n d r e t u r n i t s i d . O n c e y o u h a v e a s u b a c c o u n t i d , y o u c a n t r a n s f e r f u n d s b e t w e e n i t a n d y o u r m a i n ( m a s t e r ) a c c o u n t u s i n g t h e
t r a n s f e r s e n d p o i n t . I n o r d e r t o p l a c e o r d e r s , v i e w h i s t o r y , o r t a k e o t h e r a c t i o n s i n t h e c o n t e x t o f a s u b a c c o u n t u s i n g t h e R E S T A P I , a d d t h e A p i - s u b a c c o u n t - I D h e a d e r t o t h e r e q u e s t a n d a d j u s t y o u r
r e q u e s t s i g n a t u r e a s n e e d e d . T o b e n o t i f i e d o f u p d a t e s t o s u b a c c o u n t d a t a , u s e a w e b s o c k e t c o n n e c t i o n a u t h e n t i c a t e d w i t h a s u b a c c o u n t e n a b l e d A P I k e y a n d s u b s c r i b e t o t h e s u b a c c o u n t s t r e a m s f o r t h e t y p e s o f d a t a y o u c a r e a b o u t . A s i n g l e s u b s c r i p t i o n w i l l r e c e i v e d a t a f r o m a l l s u b a c c o u n t s t h e A P I k e y i s a u t h o r i z e d t o m a n a g e . M e s s a g e s w i l l i n c l u d e a n a c c o u n t I d f i e l d w h i c h c a n b e u s e d t o a s s o c i a t e t h e m w i t h t h e c o r r e c t s u b a c c o u n t . F o r s u b a c c o u n t s t r e a m s t h a t i n c l u d e a s e q u e n c e n u m b e r f o r s y n c h r o n i z i n g w i t h t h e s e r v e r , t h e s e q u e n c e n u m b e r i s i n d e p e n d e n t f o r e a c h s u b a c c o u n t .
B e s t P r a c t i c e s
(一) G e n e r a t e a s i n g l e s u b a c c o u n t p e r u s e r (二) D o N O T p r e - g e n e r a t e a n d s t o r e s u b a c c o u n t s o r a d d r e s s e s i n a d v a n c e (三) O n l y g e n e r a t e n e w w a l l e t a d d r e s s e s u p o n t h e u s e r ' s i n i t i a l r e q u e s t t o d e p o s i t . ( A d d r e s s e s a r e n o t r e q u i r e d t o t r a d e o r w i t h d r a w ) (四) U s e t h e s u b a c c o u n t w e b s o c k e t s t r e a m s t o a v o i d p o l l i n g .
A c c o u n t
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t
R e t r i e v e i n f o r m a t i o n f o r t h e a c c o u n t a s s o c i a t e d w i t h t h e r e q u e s t . F o r n o w , i t o n l y e c h o e s t h e s u b a c c o u n t i f o n e w a s s p e c i f i e d i n t h e h e a d e r , w h i c h c a n b e u s e d t o v e r i f y t h a t o n e i s o p e r a t i n g o n t h e i n t e n d e d a c c o u n t . M o r e f i e l d s w i l l b e a d d e d l a t e r .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/account2 0 0 O K
A c c o u n t
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"subaccountId" : "string (uuid)" ,
"accountId" : "string (uuid)" ,
"actionsNeeded" : [
"string"
]
}
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / f e e s / f i a t
G e t f i a t t r a n s a c t i o n f e e s
2 0 0 O K
F i a t T r a n s a c t i o n F e e
OK t y p e
F i a t T r a n s a c t i o n F e e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"fees" : "number (double)" ,
"currencySymbol" : "string" ,
"transactionType" : "string" ,
"transferType" : "string" ,
"feeType" : "string"
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / f e e s / f i a t / { c u r r e n c y S y m b o l } G e t f i a t t r a n s a c t i o n f e e s b y c u r r e n c y s y m b o l
c u r r e n c y S y m b o l :
s t r i n g
i n p a t h ( n o d e s c r i p t i o n )
2 0 0 O K
F i a t T r a n s a c t i o n F e e
OK t y p e
F i a t T r a n s a c t i o n F e e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"fees" : "number (double)" ,
"currencySymbol" : "string" ,
"transactionType" : "string" ,
"transferType" : "string" ,
"feeType" : "string"
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / f e e s / t r a d i n g
G e t t r a d e f e e s f o r e a c h m a r k e t s w h e n m a r k e t S y m b o l i s n o t p r o v i d e d
2 0 0 O K
C o m m i s s i o n R a t e s W i t h M a r k e t
OK t y p e
C o m m i s s i o n R a t e s W i t h M a r k e t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"marketSymbol" : "string" ,
"makerRate" : "number (double)" ,
"takerRate" : "number (double)"
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / f e e s / t r a d i n g / { m a r k e t S y m b o l } G e t t r a d e f e e f o r t h e g i v e n m a r k e t S y m b o l
m a r k e t S y m b o l :
s t r i n g
i n p a t h ( n o d e s c r i p t i o n )
2 0 0 O K
C o m m i s s i o n R a t e s W i t h M a r k e t
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"marketSymbol" : "string" ,
"makerRate" : "number (double)" ,
"takerRate" : "number (double)"
}
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / v o l u m e
G e t 3 0 d a y v o l u m e f o r a c c o u n t
2 0 0 O K
A c c o u n t V o l u m e
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"updated" : "string (date-time)" ,
"volume30days" : "number (double)"
}
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / p e r m i s s i o n s / m a r k e t s G e t t r a d i n g p e r m i s s i o n s
2 0 0 O K
M a r k e t P o l i c y
OK t y p e
M a r k e t P o l i c y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"view" : "boolean" ,
"buy" : "boolean" ,
"sell" : "boolean"
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / p e r m i s s i o n s / m a r k e t s / { m a r k e t S y m b o l } G e t t r a d i n g p e r m i s s i o n s f o r a s i n g l e m a r k e t
m a r k e t S y m b o l :
s t r i n g
i n p a t h ( n o d e s c r i p t i o n )
2 0 0 O K
M a r k e t P o l i c y
OK t y p e
M a r k e t P o l i c y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"view" : "boolean" ,
"buy" : "boolean" ,
"sell" : "boolean"
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / p e r m i s s i o n s / c u r r e n c i e s G e t c u r r e n c y p e r m i s s i o n s
2 0 0 O K
C u r r e n c y P o l i c y
OK t y p e
C u r r e n c y P o l i c y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"view" : "boolean" ,
"deposit" : {
"blockchain" : "boolean" ,
"creditCard" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
},
"withdraw" : {
"blockchain" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
}
}
]
A u t h e n t i c a t e d A c c o u n t
G E T / a c c o u n t / p e r m i s s i o n s / c u r r e n c i e s / { c u r r e n c y S y m b o l } G e t c u r r e n c y p e r m i s s i o n s f o r a s i n g l e c u r r e n c y
c u r r e n c y S y m b o l :
s t r i n g
i n p a t h ( n o d e s c r i p t i o n )
2 0 0 O K
C u r r e n c y P o l i c y
OK t y p e
C u r r e n c y P o l i c y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"view" : "boolean" ,
"deposit" : {
"blockchain" : "boolean" ,
"creditCard" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
},
"withdraw" : {
"blockchain" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
}
}
]
A d d r e s s e s
A u t h e n t i c a t e d A d d r e s s e s
G E T / a d d r e s s e s
L i s t d e p o s i t a d d r e s s e s t h a t h a v e b e e n r e q u e s t e d o r p r o v i s i o n e d .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/addresses2 0 0 O K
A d d r e s s
OK t y p e
A d d r e s s
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"status" : "string" ,
"currencySymbol" : "string" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
]
A u t h e n t i c a t e d A d d r e s s e s
P O S T / a d d r e s s e s
R e q u e s t p r o v i s i o n i n g o f a d e p o s i t a d d r e s s f o r a c u r r e n c y f o r w h i c h n o a d d r e s s h a s b e e n r e q u e s t e d o r p r o v i s i o n e d .
N e w A d d r e s s
i n f o r m a t i o n i n c l u d i n g I D o f t h e c u r r e n c y t o p r o v i s i o n a d e p o s i t a d d r e s s f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/addressesR e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{
"currencySymbol" : "string"
}
2 0 1 C r e a t e d
A d d r e s s
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"status" : "string" ,
"currencySymbol" : "string" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
A u t h e n t i c a t e d A d d r e s s e s
G E T / a d d r e s s e s / { c u r r e n c y S y m b o l }
R e t r i e v e t h e s t a t u s o f t h e d e p o s i t a d d r e s s f o r a p a r t i c u l a r c u r r e n c y f o r w h i c h o n e h a s b e e n r e q u e s t e d o r p r o v i s i o n e d .
c u r r e n c y S y m b o l :
s t r i n g
i n p a t h s y m b o l o f t h e c u r r e n c y t o r e t r i e v e t h e d e p o s i t a d d r e s s f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/addresses/{currencySymbol}2 0 0 O K
A d d r e s s
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"status" : "string" ,
"currencySymbol" : "string" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
B a l a n c e s
A u t h e n t i c a t e d B a l a n c e s
G E T / b a l a n c e s
L i s t a c c o u n t b a l a n c e s a c r o s s a v a i l a b l e c u r r e n c i e s . R e t u r n s a B a l a n c e e n t r y f o r e a c h c u r r e n c y f o r w h i c h t h e r e i s e i t h e r a b a l a n c e o r a n a d d r e s s .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/balances2 0 0 O K
B a l a n c e
OK t y p e
B a l a n c e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"currencySymbol" : "string" ,
"total" : "number (double)" ,
"available" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d B a l a n c e s
H E A D / b a l a n c e s
G e t s e q u e n c e o f b a l a n c e s s n a p s h o t .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
A u t h e n t i c a t e d B a l a n c e s
G E T / b a l a n c e s / { c u r r e n c y S y m b o l }
R e t r i e v e a c c o u n t b a l a n c e f o r a s p e c i f i c c u r r e n c y . R e q u e s t w i l l a l w a y s s u c c e e d w h e n t h e c u r r e n c y e x i s t s , r e g a r d l e s s o f w h e t h e r t h e r e i s a b a l a n c e o r a d d r e s s .
c u r r e n c y S y m b o l :
s t r i n g
i n p a t h u n i q u e s y m b o l o f t h e c u r r e n c y t o r e t r i e v e t h e a c c o u n t b a l a n c e f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/balances/{currencySymbol}2 0 0 O K
B a l a n c e
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"currencySymbol" : "string" ,
"total" : "number (double)" ,
"available" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
B a t c h
A u t h e n t i c a t e d B a t c h
P O S T / b a t c h
C r e a t e a n e w b a t c h r e q u e s t . C u r r e n t l y b a t c h r e q u e s t s a r e l i m i t e d t o p l a c i n g a n d c a n c e l l i n g o r d e r s . T h e r e q u e s t m o d e l c o r r e s p o n d s t o t h e e q u i v a l e n t i n d i v i d u a l o p e r a t i o n s . B a t c h o p e r a t i o n s a r e e x e c u t e d s e q u e n t i a l l y i n t h e o r d e r t h e y a r e l i s t e d i n t h e r e q u e s t . T h e r e s p o n s e w i l l r e t u r n o n e r e s u l t f o r e a c h o p e r a t i o n i n t h e r e q u e s t i n t h e s a m e o r d e r . T h e s t a t u s a n d r e s p o n s e p a y l o a d a r e t h e s a m e a s t h e r e s p o n s e s w o u l d b e i f i n d i v i d u a l A P I r e q u e s t s w e r e m a d e f o r e a c h o p e r a t i o n .
L i s t o f o p e r a t i o n s i n t h e b a t c h
R e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
[
{
"resource" : "string" ,
"operation" : "string" ,
"payload" : "object"
}
]
R e q u e s t B o d y E x a m p l e
[
{
"resource": "order",
"operation": "post",
"payload": {
"marketSymbol": "BTC-USD",
"direction": "BUY",
"type": "LIMIT",
"quantity": 1,
"limit": 20000,
"timeInForce": "GOOD_TIL_CANCELLED"
}
},
{
"resource": "order",
"operation": "post",
"payload": {
"marketSymbol": "BTC-USD",
"direction": "BUY",
"type": "LIMIT",
"quantity": 1,
"limit": 20050,
"timeInForce": "GOOD_TIL_CANCELLED"
}
},
{
"resource": "order",
"operation": "delete",
"payload": {
"id": "83d4dd58-cba5-4fb4-881c-f77fc43009d9"
}
}
]2 0 0 O K
B a t c h R e s p o n s e
OK t y p e
B a t c h R e s p o n s e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"status" : "integer (int32)" ,
"payload" : "object"
}
]
R e s p o n s e E x a m p l e
( 2 0 0 O K ) [
{
"status": 200,
"payload": {
"id": "21b580eb-8d5d-4855-aa11-2013e3884dce",
"marketSymbol": "BTC-USD",
"direction": "BUY",
"type": "LIMIT",
"quantity": "1",
"limit": "20000",
"timeInForce": "GOOD_TIL_CANCELLED",
"fillQuantity": "0.00000000",
"commission": "0.00000000",
"proceeds": "0.00000000",
"status": "OPEN",
"createdAt": "2020-12-02T07:19:48.75Z",
"updatedAt": "2020-12-02T07:19:48.75Z"
}
},
{
"status": 409,
"payload": {
"code": "INSUFFICIENT_FUNDS"
}
},
{
"status": 200,
"payload": {
"id": "83d4dd58-cba5-4fb4-881c-f77fc43009d9",
"marketSymbol": "BTC-USD",
"direction": "BUY",
"type": "LIMIT",
"quantity": "1.00000000",
"limit": "19950.00000000",
"timeInForce": "GOOD_TIL_CANCELLED",
"fillQuantity": "0.00000000",
"commission": "0.00000000",
"proceeds": "0.00000000",
"status": "CLOSED",
"createdAt": "2020-12-02T07:19:34.27Z",
"updatedAt": "2020-12-02T07:19:48.85Z",
"closedAt": "2020-12-02T07:19:48.85Z"
}
}
]
C o n d i t i o n a l O r d e r s
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
G E T / c o n d i t i o n a l - o r d e r s / { c o n d i t i o n a l O r d e r I d } R e t r i e v e i n f o r m a t i o n o n a s p e c i f i c c o n d i t i o n a l o r d e r .
c o n d i t i o n a l O r d e r I d :
s t r i n g ( u u i d ) i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f c o n d i t i o n a l o r d e r t o r e t r i e v e
2 0 0 O K
C o n d i t i o n a l O r d e r
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
D E L E T E / c o n d i t i o n a l - o r d e r s / { c o n d i t i o n a l O r d e r I d } C a n c e l a c o n d i t i o n a l o r d e r .
c o n d i t i o n a l O r d e r I d :
s t r i n g ( u u i d ) i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f o r d e r t o c a n c e l
2 0 0 O K
C o n d i t i o n a l O r d e r
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
G E T / c o n d i t i o n a l - o r d e r s / c l o s e d
L i s t c l o s e d c o n d i t i o n a l o r d e r s . S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C l o s e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C l o s e d A t f i e l d .
m a r k e t S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y m a r k e t ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
C o n d i t i o n a l O r d e r
OK t y p e
C o n d i t i o n a l O r d e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
G E T / c o n d i t i o n a l - o r d e r s / o p e n
L i s t o p e n c o n d i t i o n a l o r d e r s .
m a r k e t S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y m a r k e t ( o p t i o n a l )
2 0 0 O K
C o n d i t i o n a l O r d e r
OK t y p e
C o n d i t i o n a l O r d e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
H E A D / c o n d i t i o n a l - o r d e r s / o p e n
G e t s e q u e n c e o f o p e n c o n d i t i o n a l o r d e r s s n a p s h o t .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
A u t h e n t i c a t e d C o n d i t i o n a l O r d e r s
P O S T / c o n d i t i o n a l - o r d e r s
C r e a t e a n e w c o n d i t i o n a l o r d e r .
N e w C o n d i t i o n a l O r d e r
i n f o r m a t i o n s p e c i f y i n g t h e c o n d i t i o n a l o r d e r t o c r e a t e
R e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)"
}
2 0 1 C r e a t e d
C o n d i t i o n a l O r d e r
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
C u r r e n c i e s
C u r r e n c i e s
G E T / c u r r e n c i e s
L i s t c u r r e n c i e s .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/currencies2 0 0 O K
C u r r e n c y
OK t y p e
C u r r e n c y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"name" : "string" ,
"coinType" : "string" ,
"status" : "string" ,
"minConfirmations" : "integer (int32)" ,
"notice" : "string" ,
"txFee" : "number (double)" ,
"logoUrl" : "string" ,
"prohibitedIn" : [
"string"
],
"baseAddress" : "string" ,
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
]
C u r r e n c i e s
G E T / c u r r e n c i e s / { s y m b o l }
R e t r i e v e i n f o o n a s p e c i f i e d c u r r e n c y .
s y m b o l :
s t r i n g
i n p a t h s y m b o l o f t h e c u r r e n c y t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/currencies/{symbol}2 0 0 O K
C u r r e n c y
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"symbol" : "string" ,
"name" : "string" ,
"coinType" : "string" ,
"status" : "string" ,
"minConfirmations" : "integer (int32)" ,
"notice" : "string" ,
"txFee" : "number (double)" ,
"logoUrl" : "string" ,
"prohibitedIn" : [
"string"
],
"baseAddress" : "string" ,
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
D e p o s i t s
A u t h e n t i c a t e d D e p o s i t s
G E T / d e p o s i t s / o p e n
L i s t o p e n d e p o s i t s . R e s u l t s a r e s o r t e d i n i n v e r s e o r d e r o f U p d a t e d A t , a n d a r e l i m i t e d t o t h e f i r s t 1 0 0 0 .
s t a t u s :
s t r i n g
P E N D I N G
i n q u e r y f i l t e r b y a n o p e n d e p o s i t s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/deposits/open2 0 0 O K
D e p o s i t
OK t y p e
D e p o s i t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d D e p o s i t s
H E A D / d e p o s i t s / o p e n
G e t o p e n d e p o s i t s s e q u e n c e .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
A u t h e n t i c a t e d D e p o s i t s
G E T / d e p o s i t s / c l o s e d
L i s t c l o s e d d e p o s i t s . S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C o m p l e t e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C o m p l e t e d A t f i e l d .
s t a t u s :
s t r i n g
C O M P L E T E D ,
O R P H A N E D ,
I N V A L I D A T E D i n q u e r y f i l t e r b y d e p o s i t s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/deposits/closed2 0 0 O K
D e p o s i t
OK t y p e
D e p o s i t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d D e p o s i t s
G E T / d e p o s i t s / B y T x I d / { t x I d }
R e t r i e v e s a l l d e p o s i t s f o r t h i s a c c o u n t w i t h t h e g i v e n T x I d
t x I d :
s t r i n g
i n p a t h t h e t r a n s a c t i o n i d t o l o o k u p
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/deposits/ByTxId/{txId}2 0 0 O K
D e p o s i t
OK t y p e
D e p o s i t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d D e p o s i t s
G E T / d e p o s i t s / { d e p o s i t I d }
R e t r i e v e i n f o r m a t i o n f o r a s p e c i f i c d e p o s i t .
d e p o s i t I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f t h e d e p o s i t t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/deposits/{depositId}2 0 0 O K
D e p o s i t
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
E x e c u t i o n s
A u t h e n t i c a t e d E x e c u t i o n s
G E T / e x e c u t i o n s / { e x e c u t i o n I d }
R e t r i e v e i n f o r m a t i o n o n a s p e c i f i c e x e c u t i o n . N O T E : E x e c u t i o n s f r o m b e f o r e 5 / 2 7 / 2 0 1 9 a r e n o t a v a i l a b l e . A l s o , t h e r e m a y b e a d e l a y b e f o r e a n e x e c u t e d t r a d e i s v i s i b l e i n t h i s e n d p o i n t .
e x e c u t i o n I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f e x e c u t i o n t o r e t r i e v e
2 0 0 O K
E x e c u t i o n
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"orderId" : "string (uuid)" ,
"commission" : "number (double)" ,
"isTaker" : "boolean"
}
A u t h e n t i c a t e d E x e c u t i o n s
G E T / e x e c u t i o n s
L i s t h i s t o r i c a l e x e c u t i o n s f o r a c c o u n t .
P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e E x e c u t e d f i e l d . N O T E : E x e c u t i o n s f r o m b e f o r e 5 / 2 7 / 2 0 1 9 a r e n o t a v a i l a b l e . A l s o , t h e r e m a y b e a d e l a y b e f o r e a n e x e c u t e d t r a d e i s v i s i b l e i n t h i s e n d p o i n t .
m a r k e t S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y m a r k e t ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
E x e c u t i o n
OK t y p e
E x e c u t i o n
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"orderId" : "string (uuid)" ,
"commission" : "number (double)" ,
"isTaker" : "boolean"
}
]
A u t h e n t i c a t e d E x e c u t i o n s
G E T / e x e c u t i o n s / l a s t - i d
G e t s s e q u e n c e n u m b e r a n d l a s t e x e c u t i o n i d .
2 0 0 O K
E x e c u t i o n L a s t I d
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"lastId" : "string (uuid)"
}
A u t h e n t i c a t e d E x e c u t i o n s
H E A D / e x e c u t i o n s / l a s t - i d
G e t s e q u e n c e n u m b e r f o r e x e c u t i o n s .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n F u n d s T r a n s f e r M e t h o d s
A u t h e n t i c a t e d F u n d s T r a n s f e r M e t h o d s
G E T / f u n d s - t r a n s f e r - m e t h o d s / { f u n d s T r a n s f e r M e t h o d I d } G e t d e t a i l s a b o u t a l i n k e d b a n k a c c o u n t
f u n d s T r a n s f e r M e t h o d I d :
s t r i n g ( u u i d ) i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f f u n d s t r a n s f e r m e t h o d t o r e t r i e v e
2 0 0 O K
F u n d s T r a n s f e r M e t h o d
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"friendlyName" : "string" ,
"bankName" : "string" ,
"accountNumber" : "string" ,
"state" : "string" ,
"type" : "string" ,
"depositOnly" : "boolean"
}
M a r k e t s
M a r k e t s
G E T / m a r k e t s
L i s t m a r k e t s .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets2 0 0 O K
M a r k e t
OK t y p e
M a r k e t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"baseCurrencySymbol" : "string" ,
"quoteCurrencySymbol" : "string" ,
"minTradeSize" : "number (double)" ,
"precision" : "integer (int32)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"notice" : "string" ,
"prohibitedIn" : [
"string"
],
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
]
M a r k e t s
G E T / m a r k e t s / s u m m a r i e s
L i s t s u m m a r i e s o f t h e l a s t 2 4 h o u r s o f a c t i v i t y f o r a l l m a r k e t s .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/summaries2 0 0 O K
M a r k e t S u m m a r y
OK t y p e
M a r k e t S u m m a r y
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)" ,
"percentChange" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
]
M a r k e t s
H E A D / m a r k e t s / s u m m a r i e s
R e t r i e v e t h e c u r r e n t s e q u e n c e n u m b e r f o r t h e m a r k e t s u m m a r i e s s n a p s h o t .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
M a r k e t s
G E T / m a r k e t s / t i c k e r s
L i s t t i c k e r s f o r a l l m a r k e t s .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/tickers2 0 0 O K
T i c k e r
OK t y p e
T i c k e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
]
M a r k e t s
H E A D / m a r k e t s / t i c k e r s
R e t r i e v e t h e c u r r e n t s e q u e n c e n u m b e r f o r t h e t i c k e r s s n a p s h o t .
2 0 0 O K
T i c k e r
OK t y p e
T i c k e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
]
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / t i c k e r R e t r i e v e t h e t i c k e r f o r a s p e c i f i c m a r k e t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e t i c k e r f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/{marketSymbol}/ticker2 0 0 O K
T i c k e r
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l }
R e t r i e v e i n f o r m a t i o n f o r a s p e c i f i c m a r k e t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/{marketSymbol}2 0 0 O K
M a r k e t
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"symbol" : "string" ,
"baseCurrencySymbol" : "string" ,
"quoteCurrencySymbol" : "string" ,
"minTradeSize" : "number (double)" ,
"precision" : "integer (int32)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"notice" : "string" ,
"prohibitedIn" : [
"string"
],
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / s u m m a r y R e t r i e v e s u m m a r y o f t h e l a s t 2 4 h o u r s o f a c t i v i t y f o r a s p e c i f i c m a r k e t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e s u m m a r y f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/{marketSymbol}/summary2 0 0 O K
M a r k e t S u m m a r y
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"symbol" : "string" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)" ,
"percentChange" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / o r d e r b o o k R e t r i e v e t h e o r d e r b o o k f o r a s p e c i f i c m a r k e t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e o r d e r b o o k f o r
d e p t h :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m d e p t h o f o r d e r b o o k t o r e t u r n ( o p t i o n a l , a l l o w e d v a l u e s a r e [ 1 , 2 5 , 5 0 0 ] , d e f a u l t i s 2 5 )
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/{marketSymbol}/orderbook2 0 0 O K
O r d e r B o o k
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"bid" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
],
"ask" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
]
}
M a r k e t s
H E A D / m a r k e t s / { m a r k e t S y m b o l } / o r d e r b o o k R e t r i e v e t h e c u r r e n t s e q u e n c e n u m b e r f o r t h e s p e c i f i e d m a r k e t ' s o r d e r b o o k s n a p s h o t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e o r d e r b o o k f o r
d e p t h :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m d e p t h o f o r d e r b o o k t o r e t u r n ( o p t i o n a l , a l l o w e d v a l u e s a r e [ 1 , 2 5 , 5 0 0 ] , d e f a u l t i s 2 5 )
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / t r a d e s R e t r i e v e t h e r e c e n t t r a d e s f o r a s p e c i f i c m a r k e t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e r e c e n t t r a d e s f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/markets/{marketSymbol}/trades2 0 0 O K
T r a d e
OK t y p e
T r a d e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"takerSide" : "string"
}
]
M a r k e t s
H E A D / m a r k e t s / { m a r k e t S y m b o l } / t r a d e R e t r i e v e t h e c u r r e n t s e q u e n c e n u m b e r f o r t h e s p e c i f i e d m a r k e t ' s r e c e n t t r a d e s s n a p s h o t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e o r d e r b o o k f o r
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / r e c e n t R e t r i e v e r e c e n t c a n d l e s f o r a s p e c i f i c m a r k e t a n d c a n d l e i n t e r v a l . T h e m a x i m u m a g e o f t h e r e t u r n e d c a n d l e s d e p e n d s o n t h e i n t e r v a l a s f o l l o w s : ( M I N U T E _ 1 : 1 d a y , M I N U T E _ 5 : 1 d a y , H O U R _ 1 : 3 1 d a y s , D A Y _ 1 : 3 6 6 d a y s ) . C a n d l e s f o r i n t e r v a l s w i t h o u t a n y t r a d i n g a c t i v i t y w i l l m a t c h t h e p r e v i o u s c l o s e a n d v o l u m e w i l l b e z e r o .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e c a n d l e s f o r
c a n d l e I n t e r v a l :
s t r i n g
M I N U T E _ 1 ,
M I N U T E _ 5 ,
H O U R _ 1 ,
D A Y _ 1 i n p a t h d e s i r e d t i m e i n t e r v a l b e t w e e n c a n d l e s
c a n d l e T y p e :
s t r i n g
T R A D E ,
M I D P O I N T i n p a t h t y p e o f c a n d l e s ( t r a d e s o r m i d p o i n t ) . T h i s p o r t i o n o f t h e u r l m a y b e o m i t t e d i f t r a d e b a s e d c a n d l e s a r e d e s i r e d ( e . g . / c a n d l e s / { c a n d l e I n t e r v a l } / r e c e n t w i l l r e t u r n t r a d e b a s e d c a n d l e s )
2 0 0 O K
C a n d l e
OK t y p e
C a n d l e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"startsAt" : "string (date-time)" ,
"open" : "number (double)" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"close" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)"
}
]
M a r k e t s
H E A D / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / r e c e n t R e t r i e v e t h e c u r r e n t s e q u e n c e n u m b e r f o r t h e s p e c i f i e d m a r k e t ' s c a n d l e s s n a p s h o t .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e c a n d l e s f o r
c a n d l e I n t e r v a l :
s t r i n g
M I N U T E _ 1 ,
M I N U T E _ 5 ,
H O U R _ 1 ,
D A Y _ 1 i n p a t h d e s i r e d t i m e i n t e r v a l b e t w e e n c a n d l e s
c a n d l e T y p e :
s t r i n g
T R A D E ,
M I D P O I N T i n p a t h t y p e o f c a n d l e s ( t r a d e s o r m i d p o i n t ) . T h i s p o r t i o n o f t h e u r l m a y b e o m i t t e d i f t r a d e b a s e d c a n d l e s a r e d e s i r e d ( e . g . / c a n d l e s / { c a n d l e I n t e r v a l } / r e c e n t w i l l r e t u r n t r a d e b a s e d c a n d l e s )
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
M a r k e t s
G E T / m a r k e t s / { m a r k e t S y m b o l } / c a n d l e s / { c a n d l e T y p e } / { c a n d l e I n t e r v a l } / h i s t o r i c a l / { y e a r } / { m o n t h } / { d a y } R e t r i e v e r e c e n t c a n d l e s f o r a s p e c i f i c m a r k e t a n d c a n d l e i n t e r v a l . T h e d a t e r a n g e o f r e t u r n e d c a n d l e s d e p e n d s o n t h e i n t e r v a l a s f o l l o w s : ( M I N U T E _ 1 : 1 d a y , M I N U T E _ 5 : 1 d a y , H O U R _ 1 : 3 1 d a y s , D A Y _ 1 : 3 6 6 d a y s ) . C a n d l e s f o r i n t e r v a l s w i t h o u t a n y t r a d i n g a c t i v i t y w i l l m a t c h t h e p r e v i o u s c l o s e a n d v o l u m e w i l l b e z e r o .
m a r k e t S y m b o l :
s t r i n g
i n p a t h s y m b o l o f m a r k e t t o r e t r i e v e c a n d l e s f o r
c a n d l e I n t e r v a l :
s t r i n g
M I N U T E _ 1 ,
M I N U T E _ 5 ,
H O U R _ 1 ,
D A Y _ 1 i n p a t h d e s i r e d t i m e i n t e r v a l b e t w e e n c a n d l e s
y e a r :
i n t e g e r ( i n t 3 2 )
i n p a t h d e s i r e d y e a r t o s t a r t f r o m
m o n t h :
i n t e g e r ( i n t 3 2 )
i n p a t h d e s i r e d m o n t h t o s t a r t f r o m ( i f a p p l i c a b l e )
d a y :
i n t e g e r ( i n t 3 2 )
i n p a t h d e s i r e d d a y t o s t a r t f r o m ( i f a p p l i c a b l e )
c a n d l e T y p e :
s t r i n g
T R A D E ,
M I D P O I N T i n p a t h t y p e o f c a n d l e s ( t r a d e s o r m i d p o i n t ) . T h i s p o r t i o n o f t h e u r l m a y b e o m i t t e d i f t r a d e b a s e d c a n d l e s a r e d e s i r e d ( e . g . / c a n d l e s / { c a n d l e I n t e r v a l } / h i s t o r i c a l / { y e a r } w i l l r e t u r n t r a d e b a s e d c a n d l e s )
2 0 0 O K
C a n d l e
OK t y p e
C a n d l e
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"startsAt" : "string (date-time)" ,
"open" : "number (double)" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"close" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)"
}
]
O r d e r s
A u t h e n t i c a t e d O r d e r s
G E T / o r d e r s / c l o s e d
L i s t c l o s e d o r d e r s .
S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C l o s e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C l o s e d A t f i e l d .
m a r k e t S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y m a r k e t ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/orders/closed2 0 0 O K
O r d e r
OK t y p e
O r d e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
]
A u t h e n t i c a t e d O r d e r s
G E T / o r d e r s / o p e n
L i s t o p e n o r d e r s .
m a r k e t S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y m a r k e t ( o p t i o n a l )
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/orders/open2 0 0 O K
O r d e r
OK t y p e
O r d e r
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
]
A u t h e n t i c a t e d O r d e r s
D E L E T E / o r d e r s / o p e n
B u l k c a n c e l a l l o p e n o r d e r s ( c a n b e l i m i t e d t o a s p e c i f i e d m a r k e t )
m a r k e t S y m b o l :
s t r i n g
i n q u e r y ( n o d e s c r i p t i o n )
2 0 0 O K
B u l k C a n c e l R e s u l t
OK t y p e
B u l k C a n c e l R e s u l t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"statusCode" : "string" ,
"result" : {
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
}
]
A u t h e n t i c a t e d O r d e r s
H E A D / o r d e r s / o p e n
G e t s e q u e n c e o f o p e n o r d e r s s n a p s h o t .
2 0 0 O K
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n
A u t h e n t i c a t e d O r d e r s
G E T / o r d e r s / { o r d e r I d }
R e t r i e v e i n f o r m a t i o n o n a s p e c i f i c o r d e r .
o r d e r I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f o r d e r t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/orders/{orderId}2 0 0 O K
O r d e r
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
A u t h e n t i c a t e d O r d e r s
D E L E T E / o r d e r s / { o r d e r I d }
C a n c e l a n o r d e r .
o r d e r I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f o r d e r t o c a n c e l
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/orders/{orderId}2 0 0 O K
O r d e r
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
A u t h e n t i c a t e d O r d e r s
G E T / o r d e r s / { o r d e r I d } / e x e c u t i o n s R e t r i e v e e x e c u t i o n s f o r a s p e c i f i c o r d e r . R e s u l t s a r e s o r t e d i n i n v e r s e o r d e r o f e x e c u t i o n t i m e , a n d a r e l i m i t e d t o t h e f i r s t 1 0 0 0 . N O T E : E x e c u t i o n s f r o m b e f o r e 5 / 2 7 / 2 0 1 9 a r e n o t a v a i l a b l e . A l s o , t h e r e m a y b e a d e l a y b e f o r e a n e x e c u t e d t r a d e i s v i s i b l e i n t h i s e n d p o i n t .
o r d e r I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f o r d e r t o r e t r i e v e e x e c u t i o n s f o r
2 0 0 O K
E x e c u t i o n
OK t y p e
E x e c u t i o n
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"orderId" : "string (uuid)" ,
"commission" : "number (double)" ,
"isTaker" : "boolean"
}
]
A u t h e n t i c a t e d O r d e r s
P O S T / o r d e r s
C r e a t e a n e w o r d e r .
N e w O r d e r
i n f o r m a t i o n s p e c i f y i n g t h e o r d e r t o c r e a t e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/ordersR e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
}
2 0 1 C r e a t e d
O r d e r
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
P i n g
P i n g
G E T / p i n g
P i n g s t h e s e r v i c e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/ping2 0 0 O K
S e r v i c e P i n g
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"serverTime" : "integer (int64)"
}
S u b a c c o u n t s
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s
L i s t s u b a c c o u n t s .
( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . ) P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C r e a t e d A t f i e l d .
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/subaccounts2 0 0 O K
S u b a c c o u n t
OK t y p e
S u b a c c o u n t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"createdAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d S u b a c c o u n t s
P O S T / s u b a c c o u n t s
C r e a t e a n e w s u b a c c o u n t .
( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . )
N e w S u b a c c o u n t
i n f o r m a t i o n s p e c i f y i n g t h e s u b a c c o u n t t o c r e a t e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/subaccountsR e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{}
2 0 1 C r e a t e d
S u b a c c o u n t
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"id" : "string (uuid)" ,
"createdAt" : "string (date-time)"
}
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s / { s u b a c c o u n t I d }
R e t r i e v e d e t a i l s f o r a s p e c i f i e d s u b a c c o u n t .
( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . ) s u b a c c o u n t I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f t h e s u b a c c o u n t t o r e t r i e v e d e t a i l s f o r
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/subaccounts/{subaccountId}2 0 0 O K
S u b a c c o u n t
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"createdAt" : "string (date-time)"
}
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s / w i t h d r a w a l s / o p e n L i s t o p e n w i t h d r a w a l s f o r a l l s u b a c c o u n t s . R e s u l t s a r e s o r t e d i n i n v e r s e o r d e r o f t h e C r e a t e d A t f i e l d , a n d a r e l i m i t e d t o t h e f i r s t 1 0 0 0 .
s t a t u s :
s t r i n g
R E Q U E S T E D ,
A U T H O R I Z E D ,
P E N D I N G ,
E R R O R _ I N V A L I D _ A D D R E S S i n q u e r y f i l t e r b y a n o p e n w i t h d r a w a l s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
W i t h d r a w a l
OK t y p e
W i t h d r a w a l
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s / w i t h d r a w a l s / c l o s e d L i s t c l o s e d w i t h d r a w a l s f o r a l l s u b a c c o u n t s . S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C o m p l e t e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C o m p l e t e d A t f i e l d .
s t a t u s :
s t r i n g
C O M P L E T E D ,
C A N C E L L E D i n q u e r y f i l t e r b y w i t h d r a w a l s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
W i t h d r a w a l
OK t y p e
W i t h d r a w a l
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s / d e p o s i t s / o p e n
L i s t o p e n d e p o s i t s f o r a l l s u b a c c o u n t s . R e s u l t s a r e s o r t e d i n i n v e r s e o r d e r o f U p d a t e d A t
s t a t u s :
s t r i n g
P E N D I N G
i n q u e r y f i l t e r b y a n o p e n d e p o s i t s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
D e p o s i t
OK t y p e
D e p o s i t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d S u b a c c o u n t s
G E T / s u b a c c o u n t s / d e p o s i t s / c l o s e d L i s t c l o s e d d e p o s i t s f o r a l l s u b a c c o u n t s . S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C o m p l e t e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C o m p l e t e d A t f i e l d .
s t a t u s :
s t r i n g
C O M P L E T E D ,
O R P H A N E D ,
I N V A L I D A T E D i n q u e r y f i l t e r b y d e p o s i t s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
2 0 0 O K
D e p o s i t
OK t y p e
D e p o s i t
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
T r a n s f e r s
A u t h e n t i c a t e d T r a n s f e r s
G E T / t r a n s f e r s / s e n t
L i s t s e n t t r a n s f e r s . ( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . ) P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e E x e c u t e d f i e l d .
t o S u b a c c o u n t I d :
s t r i n g ( u u i d )
i n q u e r y
( u u i d - f o r m a t t e d s t r i n g ) - f i l t e r t r a n s f e r s t o a s u b a c c o u n t i d ( o p t i o n a l )
t o M a s t e r A c c o u n t :
b o o l e a n
i n q u e r y f i l t e r t r a n s f e r s t o m a s t e r a c c o u n t ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/transfers/sent2 0 0 O K
S e n t T r a n s f e r I n f o
OK t y p e
S e n t T r a n s f e r I n f o
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"toSubaccountId" : "string (uuid)" ,
"toMasterAccount" : "boolean" ,
"id" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"executedAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d T r a n s f e r s
G E T / t r a n s f e r s / r e c e i v e d
L i s t r e c e i v e d t r a n s f e r s . ( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . ) P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e E x e c u t e d f i e l d .
f r o m S u b a c c o u n t I d :
s t r i n g ( u u i d )
i n q u e r y
( u u i d - f o r m a t t e d s t r i n g ) - f i l t e r t r a n s f e r s f r o m a s u b a c c o u n t i d ( o p t i o n a l )
f r o m M a s t e r A c c o u n t :
b o o l e a n
i n q u e r y f i l t e r t r a n s f e r s f r o m m a s t e r a c c o u n t ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/transfers/received2 0 0 O K
R e c e i v e d T r a n s f e r I n f o
OK t y p e
R e c e i v e d T r a n s f e r I n f o
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"fromSubaccountId" : "string (uuid)" ,
"fromMasterAccount" : "boolean" ,
"id" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"executedAt" : "string (date-time)"
}
]
A u t h e n t i c a t e d T r a n s f e r s
G E T / t r a n s f e r s / { t r a n s f e r I d }
R e t r i e v e i n f o r m a t i o n o n t h e s p e c i f i e d t r a n s f e r . ( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . )
t r a n s f e r I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f t h e t r a n s f e r t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/transfers/{transferId}2 0 0 O K
R e c e i v e d T r a n s f e r I n f o
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"fromSubaccountId" : "string (uuid)" ,
"fromMasterAccount" : "boolean" ,
"id" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"executedAt" : "string (date-time)"
}
A u t h e n t i c a t e d T r a n s f e r s
P O S T / t r a n s f e r s
E x e c u t e s a n e w t r a n s f e r . ( N O T E : T h i s A P I i s l i m i t e d t o p a r t n e r s a n d n o t a v a i l a b l e f o r t r a d e r s . )
N e w T r a n s f e r
i n f o r m a t i o n s p e c i f y i n g t h e t r a n s f e r t o e x e c u t e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/transfersR e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{
"toSubaccountId" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"toMasterAccount" : "boolean"
}
2 0 1 C r e a t e d
N e w T r a n s f e r
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"toSubaccountId" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"toMasterAccount" : "boolean"
}
W i t h d r a w a l s
A u t h e n t i c a t e d W i t h d r a w a l s
G E T / w i t h d r a w a l s / o p e n
L i s t o p e n w i t h d r a w a l s . R e s u l t s a r e s o r t e d i n i n v e r s e o r d e r o f t h e C r e a t e d A t f i e l d , a n d a r e l i m i t e d t o t h e f i r s t 1 0 0 0 .
s t a t u s :
s t r i n g
R E Q U E S T E D ,
A U T H O R I Z E D ,
P E N D I N G ,
E R R O R _ I N V A L I D _ A D D R E S S i n q u e r y f i l t e r b y a n o p e n w i t h d r a w a l s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawals/open2 0 0 O K
W i t h d r a w a l
OK t y p e
W i t h d r a w a l
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d W i t h d r a w a l s
G E T / w i t h d r a w a l s / c l o s e d
L i s t c l o s e d w i t h d r a w a l s . S t a r t D a t e a n d E n d D a t e f i l t e r s a p p l y t o t h e C o m p l e t e d A t f i e l d . P a g i n a t i o n a n d t h e s o r t o r d e r o f t h e r e s u l t s a r e i n i n v e r s e o r d e r o f t h e C o m p l e t e d A t f i e l d .
s t a t u s :
s t r i n g
C O M P L E T E D ,
C A N C E L L E D i n q u e r y f i l t e r b y w i t h d r a w a l s t a t u s ( o p t i o n a l )
c u r r e n c y S y m b o l :
s t r i n g
i n q u e r y f i l t e r b y c u r r e n c y ( o p t i o n a l )
n e x t P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n :
s t r i n g
i n q u e r y T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e :
i n t e g e r ( i n t 3 2 )
i n q u e r y m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
s t a r t D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e :
s t r i n g ( d a t e - t i m e )
i n q u e r y ( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawals/closed2 0 0 O K
W i t h d r a w a l
OK t y p e
W i t h d r a w a l
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d W i t h d r a w a l s
G E T / w i t h d r a w a l s / B y T x I d / { t x I d }
R e t r i e v e s a l l w i t h d r a w a l s f o r t h i s a c c o u n t w i t h t h e g i v e n T x I d
t x I d :
s t r i n g
i n p a t h t h e t r a n s a c t i o n i d t o l o o k u p
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawals/ByTxId/{txId}2 0 0 O K
W i t h d r a w a l
OK t y p e
W i t h d r a w a l
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
[
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
]
A u t h e n t i c a t e d W i t h d r a w a l s
G E T / w i t h d r a w a l s / { w i t h d r a w a l I d }
R e t r i e v e i n f o r m a t i o n o n a s p e c i f i e d w i t h d r a w a l .
w i t h d r a w a l I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f w i t h d r a w a l t o r e t r i e v e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawals/{withdrawalId}2 0 0 O K
W i t h d r a w a l
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
A u t h e n t i c a t e d W i t h d r a w a l s
D E L E T E / w i t h d r a w a l s / { w i t h d r a w a l I d } C a n c e l a w i t h d r a w a l . ( W i t h d r a w a l s c a n o n l y b e c a n c e l l e d i f s t a t u s i s R E Q U E S T E D , A U T H O R I Z E D , o r E R R O R _ I N V A L I D _ A D D R E S S . )
w i t h d r a w a l I d :
s t r i n g ( u u i d )
i n p a t h
( u u i d - f o r m a t t e d s t r i n g ) - I D o f w i t h d r a w a l t o c a n c e l
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawals/{withdrawalId}2 0 0 O K
W i t h d r a w a l
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
A u t h e n t i c a t e d W i t h d r a w a l s
P O S T / w i t h d r a w a l s
C r e a t e a n e w w i t h d r a w a l . T o i n i t i a t e a f i a t w i t h d r a w a l s p e c i f y a f u n d s t r a n s f e r m e t h o d i d i n s t e a d o f a c r y p t o a d d r e s s .
N e w W i t h d r a w a l
i n f o r m a t i o n s p e c i f y i n g t h e w i t h d r a w a l t o c r e a t e
R e q u e s t U r l E x a m p l e https://api.bittrex.com/v3/withdrawalsR e q u e s t C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e q u e s t B o d y S c h e m a
{
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"clientWithdrawalId" : "string (uuid)"
}
2 0 1 C r e a t e d
W i t h d r a w a l
C r e a t e d
R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 1 C r e a t e d )
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
A u t h e n t i c a t e d W i t h d r a w a l s
G E T / w i t h d r a w a l s / a l l o w e d - a d d r e s s e s R e t u r n s a l i s t o f a l l o w e d a d d r e s s e s .
2 0 0 O K
A l l o w e d A d d r e s s
OK R e s p o n s e C o n t e n t - T y p e s :
a p p l i c a t i o n / j s o n R e s p o n s e S c h e m a
( 2 0 0 O K )
{
"currencySymbol" : "string" ,
"createdAt" : "string (date-time)" ,
"status" : "string" ,
"activeAt" : "string (date-time)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
W e b s o c k e t A P I
A u t h e n t i c a t e
A u t h e n t i c a t e s t h e c u r r e n t c o n n e c t i o n u s i n g a n A P I k e y . N o t e t h a t a f t e r a u t h e n t i c a t i n g , t h e c l i e n t m u s t p e r i o d i c a l l y r e n e w i t s a u t h e n t i c a t i o n . R e f e r t o t h e
w e b s o c k e t a u t h e n t i c a t i o n t o p i c f o r a d d i t i o n a l i n f o r m a t i o n . I n t h e e x a m p l e , t h e A P I k e y u s e d w a s " y o u r _ a p i _ k e y _ g o e s _ h e r e " a n d t h e s e c r e t w a s " s e c r e t " . T h e e x a m p l e r e s p o n s e s h o w s t h i s r e q u e s t f a i l i n g b e c a u s e " y o u r _ a p i _ k e y _ g o e s _ h e r e " i s n o t a v a l i d v a l u e f o r a n A P I k e y .
a p i K e y :
s t r i n g
a v a l i d A P I k e y f o r y o u r a c c o u n t
t i m e s t a m p :
s t r i n g
t h e c u r r e n t U N I X - s t y l e t i m e i n e p o c h m i l l i s e c o n d f o r m a t
r a n d o m C o n t e n t :
s t r i n g
a r a n d o m u u i d
s i g n a t u r e :
s t r i n g
r a n d o m C o n t e n t a n d t i m e s t a m p s i g n e d b y t h e a p i K e y ' s s e c r e t . R e f e r t o t h e
w e b s o c k e t a u t h e n t i c a t i o n t o p i c f o r a n e x a m p l e .
R e q u e s t P a y l o a d E x a m p l e {"H":"c3","M":"Authenticate","A":["your_api_key_goes_here",1592524115500,"e758c9d0-7603-4c8d-9ad3-3ce0141c576b","BFBD98224D5720C4F51DC30BF6B5035800A92B3B5E3124D8E2A69F6299A49D3C6AA428947693B470851AB736996A57C6A11FB60517AB24B5E3379C386688C973"],"I":1}R e s p o n s e
S o c k e t R e s p o n s e
R e s p o n s e P a y l o a d E x a m p l e {"R":{"Success":false,"ErrorCode":"INVALID_APIKEY"},"I":1}
I s A u t h e n t i c a t e d
D e t e r m i n e s i f t h e c u r r e n t c o n n e c t i o n i s a u t h e n t i c a t e d . I n t h e e x a m p l e , t h e c l i e n t i s n o t c u r r e n t l y a u t h e n t i c a t e d .
R e q u e s t P a y l o a d E x a m p l e {"H":"c3","M":"IsAuthenticated","A":[],"I":1}R e s p o n s e T r u e i f t h e c o n n e c t i o n i s a u t h e n t i c a t e d , f a l s e o t h e r w i s e
R e s p o n s e P a y l o a d E x a m p l e {"R":false,"I":1}
S u b s c r i b e
S u b s c r i b e s t o o n e o r m o r e d a t a s t r e a m s . I n t h e e x a m p l e , t h e c l i e n t s u c c e s s f u l l y s u b s c r i b e s f r o m t h e h e a r t b e a t s t r e a m a n d t h e t i c k e r s t r e a m f o r B T C / U S D .
c h a n n e l s :
A r r a y < s t r i n g >
l i s t o f s t r e a m s t o s u b s c r i b e t o
R e q u e s t P a y l o a d E x a m p l e {"H":"c3","M":"Subscribe","A":[["heartbeat","ticker_BTC-USD"]],"I":1}R e s p o n s e A r r a y <
S o c k e t R e s p o n s e >
R e s p o n s e P a y l o a d E x a m p l e {"R":[{"Success":true,"ErrorCode":null},{"Success":true,"ErrorCode":null}],"I":1}
U n s u b s c r i b e
U n s u b s c r i b e s f r o m o n e o r m o r e d a t a s t r e a m s . I n t h e e x a m p l e , t h e c l i e n t s u c c e s s f u l l y u n s u b s c r i b e s f r o m t h e t i c k e r s t r e a m f o r B T C / U S D .
c h a n n e l s :
A r r a y < s t r i n g >
l i s t o f s t r e a m s t o u n s u b s c r i b e f r o m
R e q u e s t P a y l o a d E x a m p l e {"H":"c3","M":"Unsubscribe","A":[["ticker_BTC-USD"]],"I":1}R e s p o n s e A r r a y <
S o c k e t R e s p o n s e >
R e s p o n s e P a y l o a d E x a m p l e {"R":[{"Success":true,"ErrorCode":null}],"I":1}W e b s o c k e t S t r e a m s
B a l a n c e
S e n d s a m e s s a g e w h e n t h e a u t h e n t i c a t e d u s e r ’ s t o t a l o r a v a i l a b l e b a l a n c e o f a c u r r e n c y c h a n g e s .
Subscription name
balance
Message name
balance
Unique key
accountId, currencySymbol
Snapshot from
GET /balances
Subaccount stream
subaccounts_balance
M e s s a g e s c h e m a
{
"accountId" : "string (uuid)" ,
"sequence" : "int" ,
"delta" : {
"currencySymbol" : "string" ,
"total" : "number (double)" ,
"available" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
}
C a n d l e
S e n d s a m e s s a g e a t t h e s t a r t o f e a c h c a n d l e ( b a s e d o n t h e s u b s c r i b e d i n t e r v a l ) a n d w h e n t r a d e s h a v e o c c u r r e d o n t h e m a r k e t . N o t e t h a t t h i s m e a n s o n a n a c t i v e m a r k e t y o u w i l l r e c e i v e m a n y u p d a t e s o v e r t h e c o u r s e o f e a c h c a n d l e i n t e r v a l a s t r a d e s o c c u r . Y o u w i l l a l w a y s r e c i e v e a n u p d a t e a t t h e s t a r t o f e a c h i n t e r v a l . I f n o t r a d e s o c c u r r e d y e t , t h i s u p d a t e w i l l b e a 0 - v o l u m e p l a c e h o l d e r t h a t c a r r i e s f o r w a r d t h e C l o s e o f t h e p r e v i o u s i n t e r v a l a s t h e c u r r e n t i n t e r v a l ' s O H L C v a l u e s . M e s s a g e s c h e m a
{
"sequence" : "int" ,
"marketSymbol" : "string" ,
"interval" : "string" ,
"delta" : {
"startsAt" : "string (date-time)" ,
"open" : "number (double)" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"close" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)"
}
}
m a r k e t S y m b o l :
s t r i n g
s y m b o l o f m a r k e t t o r e t r i e v e c a n d l e s f o r
c a n d l e I n t e r v a l :
s t r i n g
M I N U T E _ 1 ,
M I N U T E _ 5 ,
H O U R _ 1 ,
D A Y _ 1 d e s i r e d t i m e i n t e r v a l b e t w e e n c a n d l e s
C o n d i t i o n a l O r d e r
S e n d s a m e s s a g e w h e n o n e o f y o u r c o n d i t i o n a l o r d e r s i s c r e a t e d , m o d i f i e d , o r t r i g g e r e d
Subscription name
conditional_order
Message name
conditionalOrder
Unique key
id
Snapshot from
GET /conditional-orders/open
Subaccount stream
subaccounts_conditional_order
M e s s a g e s c h e m a
{
"accountId" : "string (uuid)" ,
"sequence" : "int" ,
"delta" : {
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
}
D e p o s i t
S e n d s a m e s s a g e w h e n a n e w d e p o s i t i s d e t e c t e d o r i t s s t a t u s c h a n g e s .
Subscription name
deposit
Message name
deposit
Unique key
id
Snapshot from
GET /deposits/open
Subaccount stream
subaccounts_deposit
M e s s a g e s c h e m a
{
"accountId" : "string (uuid)" ,
"sequence" : "int" ,
"delta" : {
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
}
E x e c u t i o n
S e n d s a m e s s a g e w h e n o n e o f t h e u s e r ' s o r d e r s i s c o m p l e t e l y o r p a r t i a l l y f i l l e d b y a t r a d e
Subscription name
execution
Message name
execution
Unique key
id
Snapshot from
GET /executions/last-id
Subaccount stream
subaccounts_execution
T h e
G E T / e x e c u t i o n s / l a s t - i d r e q u e s t r e t u r n s t h e c u r r e n t s e q u e n c e n u m b e r a n d t h e i d o f t h e m o s t r e c e n t e x e c u t i o n . I f t h a t i d i s n o t i n y o u r l o c a l c a c h e , t h e n u s e
G E T / e x e c u t i o n s t o f i l l i n a n y e x e c u t i o n s t h a t y o u m i s s e d . E x e c u t i o n s a r e i m m u t a b l e s o a n y i n f o r m a t i o n r e c e i v e d a b o u t a g i v e n e x e c u t i o n f r o m R E S T o r t h e s o c k e t w i l l b e i t s f i n a l s t a t e .
M e s s a g e s c h e m a
{
"accountId" : "string (uuid)" ,
"sequence" : "int" ,
"deltas" : [
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"orderId" : "string (uuid)" ,
"commission" : "number (double)" ,
"isTaker" : "boolean"
}
]
}
H e a r t b e a t
S e n d s a n e m p t y m e s s a g e o n a n i n t e r v a l ( c u r r e n t l y 5 s e c o n d s ) . I f y o u s t o p g e t t i n g a h e a r t b e a t t h a t m e a n s y o u r c o n n e c t i o n i s d e a d . I f y o u a r e s t i l l g e t t i n g a h e a r t b e a t b u t a r e n o t g e t t i n g u p d a t e s o n a c t i v e m a r k e t s t h e n t h a t m e a n s y o u r c o n n e c t i o n i s a l i v e b u t s o m e t h i n g e l s e i s w r o n g .
Subscription name
heartbeat
Message name
heartbeat
Unique key
n/a
Snapshot from
n/a
M e s s a g e s c h e m a
"Heartbeat messages contain no payload"
M a r k e t S u m m a r i e s
P r o v i d e s r e g u l a r u p d a t e s o f t h e c u r r e n t m a r k e t s u m m a r y d a t a f o r a l l m a r k e t s . M a r k e t s u m m a r y d a t a i s d i f f e r e n t f r o m c a n d l e s i n t h a t i t i s a r o l l i n g 2 4 - h o u r n u m b e r a s o p p o s e d t o d a t a f o r a f i x e d i n t e r v a l l i k e c a n d l e s .
Subscription name
market_summaries
Message name
marketSummaries
Unique key
symbol
Snapshot from
GET /markets/summaries
M e s s a g e s c h e m a
{
"sequence" : "int" ,
"deltas" : [
{
"symbol" : "string" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)" ,
"percentChange" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
]
}
M a r k e t S u m m a r y
P r o v i d e s r e g u l a r u p d a t e s o f t h e c u r r e n t m a r k e t s u m m a r y d a t a f o r a g i v e n m a r k e t . M a r k e t s u m m a r y d a t a i s d i f f e r e n t f r o m c a n d l e s i n t h a t i t i s a r o l l i n g 2 4 - h o u r n u m b e r a s o p p o s e d t o d a t a f o r a f i x e d i n t e r v a l l i k e c a n d l e s . T h i s s t r e a m d o e s n o t i n c l u d e a s e q u e n c e n u m b e r b e c a u s e e a c h m e s s a g e r e c e i v e d i s a f u l l s n a p s h o t o f t h e c u r r e n t s t a t e .
M e s s a g e s c h e m a
{
"symbol" : "string" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)" ,
"percentChange" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
m a r k e t S y m b o l :
s t r i n g
s y m b o l o f m a r k e t t o r e t r i e v e t h e s u m m a r y f o r
O r d e r
S e n d s m e s s a g e s w h e n t h e r e a r e c h a n g e s t o t h e u s e r ’ s o p e n o r d e r s .
Subscription name
order
Message name
order
Unique key
id
Snapshot from
GET /orders/open
Subaccount stream
subaccounts_order
M e s s a g e s c h e m a
{
"accountId" : "string (uuid)" ,
"sequence" : "int" ,
"delta" : {
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
}
O r d e r b o o k
S e n d s a m e s s a g e w h e n t h e r e a r e c h a n g e s t o t h e o r d e r b o o k w i t h i n t h e s u b s c r i b e d d e p t h . A n u p d a t e w i t h q u a n t i t y 0 m e a n s t h a t t h e r e i s n o l o n g e r a n y l i q u i d i t y a v a i l a b l e a t t h a t r a t e o r t h a t t h i s r a t e i s n o l o n g e r w i t h i n t h e s u b s c r i b e d d e p t h . F o r e x a m p l e , i f s u b s c r i b e d t o a d e p t h o f 2 5 , i f a n o r d e r i s p l a c e d a t a n e w r a t e s o m e w h e r e i n t h e m i d d l e o f t h e t o p 2 5 , t h e e n t r y t h a t w a s f o r m e r l y t h e 2 5 t h , a n d i s n o w 2 6 t h , w i l l g e t a n u p d a t e w i t h q u a n t i t y 0 . F o r t h i s r e a s o n , d e p t h i s i n c l u d e d a s p a r t o f t h e k e y d e f i n e d a b o v e . T h e f i r s t 2 5 l e v e l s o f t h e d e p t h 2 5 a n d d e p t h 5 0 0 o r d e r b o o k s w i l l b e i d e n t i c a l , b u t u p d a t e s f o r l e v e l 2 6 o f t h e d e p t h 2 5 o r d e r b o o k ( a l w a y s 0 ) m u s t b e k e p t s e p a r a t e f r o m u p d a t e s f o r t h e d e p t h 5 0 0 o r d e r b o o k i f y o u a r e s u b s c r i b e d t o b o t h .
N o t e : Y o u m u s t g e t t h e o r d e r b o o k s n a p s h o t f r o m t h e s a m e d e p t h a s y o u a r e s u b s c r i b e d t o o n t h e w e b s o c k e t . S e q u e n c e n u m b e r s a r e n o t t h e s a m e f o r d i f f e r e n t d e p t h s .
M e s s a g e s c h e m a
{
"marketSymbol" : "string" ,
"depth" : "int" ,
"sequence" : "int" ,
"bidDeltas" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
],
"askDeltas" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
]
}
m a r k e t S y m b o l :
s t r i n g
s y m b o l o f m a r k e t t o m o n i t o r o r d e r b o o k f o r
d e p t h :
s t r i n g
1 ,
25 ,
5 0 0
d e p t h o f o r d e r b o o k t o m o n i t o r
T i c k e r s
S e n d s a m e s s a g e w i t h t h e b e s t b i d p r i c e , b e s t a s k p r i c e , a n d l a s t t r a d e p r i c e f o r a l l m a r k e t s a s t h e r e a r e c h a n g e s t o t h e o r d e r b o o k o r t r a d e s . M e s s a g e s c h e m a
{
"sequence" : "int" ,
"deltas" : [
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
]
}
T i c k e r
S e n d s a m e s s a g e w i t h t h e b e s t b i d a n d a s k p r i c e f o r t h e g i v e n m a r k e t a s w e l l a s t h e l a s t t r a d e p r i c e w h e n e v e r t h e r e i s a r e l e v a n t c h a n g e t o t h e o r d e r b o o k o r a t r a d e . T h i s s t r e a m d o e s n o t i n c l u d e a s e q u e n c e n u m b e r b e c a u s e e a c h m e s s a g e r e c e i v e d i s a f u l l s n a p s h o t o f t h e c u r r e n t s t a t e .
M e s s a g e s c h e m a
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
m a r k e t S y m b o l :
s t r i n g
s y m b o l o f m a r k e t t o m o n i t o r f o r t i c k e r u p d a t e s
T r a d e
S e n d s a m e s s a g e w i t h t h e q u a n t i t y a n d r a t e o f t r a d e s o n a m a r k e t a s t h e y o c c u r . M e s s a g e s c h e m a
{
"sequence" : "int" ,
"marketSymbol" : "string" ,
"deltas" : [
{
"id" : "string (uuid)" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"takerSide" : "string"
}
]
}
m a r k e t S y m b o l :
s t r i n g
s y m b o l o f m a r k e t t o m o n i t o r f o r t r a d e s
S c h e m a D e f i n i t i o n s
A c c o u n t
s u b a c c o u n t I d : s t r i n g ( u u i d )
t h e s u b a c c o u n t I D a s s o c i a t e d w i t h t h i s r e q u e s t i f o n e w a s s p e c i f i e d i n t h e h e a d e r ( o p t i o n a l )
a c c o u n t I d : s t r i n g ( u u i d )
T h e a c c o u n t I D a s s o c i a t e d w i t h t h i s r e q u e s t o n l y f o r m a s t e r a c c o u n t s
a c t i o n s N e e d e d : s t r i n g [ ]
L i s t o f a c t i o n s t h e u s e r r e q u i r e s
E x a m p l e
{
"subaccountId" : "string (uuid)" ,
"accountId" : "string (uuid)" ,
"actionsNeeded" : [
"string"
]
}
C o m m i s s i o n R a t e s W i t h M a r k e t
m a r k e t S y m b o l : s t r i n g
M a r k e t S y m b o l
m a k e r R a t e : n u m b e r ( d o u b l e )
M a k e r R a t e
t a k e r R a t e : n u m b e r ( d o u b l e )
T a k e r R a t e
E x a m p l e
{
"marketSymbol" : "string" ,
"makerRate" : "number (double)" ,
"takerRate" : "number (double)"
}
F i a t T r a n s a c t i o n F e e
f e e s : n u m b e r ( d o u b l e )
T r a n s a c t i o n F e e s
c u r r e n c y S y m b o l : s t r i n g
C u r r e n c y S y m b o l
t r a n s a c t i o n T y p e : s t r i n g
D E P O S I T ,
W I T H D R A W A L T r a n s a c t i o n T y p e
t r a n s f e r T y p e : s t r i n g
W I R E ,
S E P A ,
I N S T A N T _ S E T T L E M E N T ,
A C H ,
S E N F u n d s t r a n s f e r t y p e
f e e T y p e : s t r i n g
F I X E D ,
P E R C E N T
F e e T y p e
E x a m p l e
{
"fees" : "number (double)" ,
"currencySymbol" : "string" ,
"transactionType" : "string" ,
"transferType" : "string" ,
"feeType" : "string"
}
A c c o u n t V o l u m e
u p d a t e d : s t r i n g ( d a t e - t i m e )
D a t e a n d t i m e i n d i c a t i n g a s w h e n v o l u m e w a s u p d a t e d
v o l u m e 3 0 d a y s : n u m b e r ( d o u b l e )
3 0 d a y v o l u m e i n f o r m a t i o n .
E x a m p l e
{
"updated" : "string (date-time)" ,
"volume30days" : "number (double)"
}
M a r k e t P o l i c y
s y m b o l : s t r i n g
u n i q u e I D f o r t h e m a r k e t t h i s p o l i c y i s a s s o c i a t e d w i t h
v i e w : b o o l e a n
t r u e i f t h e c u r r e n t u s e r s h o u l d b e s h o w n i n f o r m a t i o n a b o u t t h i s m a r k e t
b u y : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n p l a c e b u y o r d e r s o n t h i s m a r k e t
s e l l : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n p l a c e s e l l o r d e r s o n t h i s m a r k e t
E x a m p l e
{
"symbol" : "string" ,
"view" : "boolean" ,
"buy" : "boolean" ,
"sell" : "boolean"
}
C u r r e n c y P o l i c y
s y m b o l : s t r i n g
u n i q u e I D f o r t h e c u r r e n c y t h i s p o l i c y i s a s s o c i a t e d w i t h
v i e w : b o o l e a n
t r u e i f t h e c u r r e n t u s e r s h o u l d b e s h o w n i n f o r m a t i o n a b o u t t h i s c u r r e n c y
d e p o s i t :
D e p o s i t M e t h o d s
m e t h o d s f o r d e p o s i t i n g t h i s c u r r e n c y
w i t h d r a w :
W i t h d r a w M e t h o d s
m e t h o d s f o r w i t h d r a w i n g t h i s c u r r e n c y
E x a m p l e
{
"symbol" : "string" ,
"view" : "boolean" ,
"deposit" : {
"blockchain" : "boolean" ,
"creditCard" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
},
"withdraw" : {
"blockchain" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
}
}
D e p o s i t M e t h o d s
b l o c k c h a i n : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n d e p o s i t t h i s c u r r e n c y v i a b l o c k c h a i n t r a n s a c t i o n
c r e d i t C a r d : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n d e p o s i t t h i s c u r r e n c y v i a c r e d i t c a r d
w i r e T r a n s f e r : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n d e p o s i t t h i s c u r r e n c y v i a w i r e t r a n s f e r
a c h : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n d e p o s i t t h i s c u r r e n c y v i a A C H
E x a m p l e
{
"blockchain" : "boolean" ,
"creditCard" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
}
W i t h d r a w M e t h o d s
b l o c k c h a i n : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n w i t h d r a w t h i s c u r r e n c y v i a b l o c k c h a i n t r a n s a c t i o n
w i r e T r a n s f e r : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n w i t h d r a w t h i s c u r r e n c y v i a w i r e t r a n s f e r
a c h : b o o l e a n
t r u e i f t h e c u r r e n t u s e r c a n w i t h d r a w t h i s c u r r e n c y v i a A C H
E x a m p l e
{
"blockchain" : "boolean" ,
"wireTransfer" : "boolean" ,
"ach" : "boolean"
}
A d d r e s s
s t a t u s : s t r i n g
R E Q U E S T E D ,
P R O V I S I O N E D t h e s t a t u s o f t h i s d e p o s i t a d d r e s s
c u r r e n c y S y m b o l : s t r i n g
t h e u n i q u e I D o f t h e c u r r e n c y t h i s d e p o s i t a d d r e s s i s f o r
c r y p t o A d d r e s s : s t r i n g
t h e c r y p t o g r a p h i c d e p o s i t a d d r e s s ( o p t i o n a l , o n l y s e t i f S t a t u s i s P R O V I S I O N E D )
c r y p t o A d d r e s s T a g : s t r i n g
t h e c r y p t o g r a p h i c d e p o s i t a d d r e s s t a g ( o p t i o n a l , o n l y s e t i f S t a t u s i s P R O V I S I O N E D ) N O T E : T h i s o n l y a p p l i e s f o r c u r r e n c i e s w h o s e c o i n T y p e r e q u i r e s i t .
E x a m p l e
{
"status" : "string" ,
"currencySymbol" : "string" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
N e w A d d r e s s
c u r r e n c y S y m b o l : s t r i n g
t h e c u r r e n c y I D t o p r o v i s i o n a n e w a d d r e s s f o r
E x a m p l e
{
"currencySymbol" : "string"
}
B a l a n c e
c u r r e n c y S y m b o l : s t r i n g
u n i q u e I D f o r t h e c u r r e n c y t h i s b a l a n c e i s a s s o c i a t e d w i t h
t o t a l : n u m b e r ( d o u b l e )
t o t a l a m o u n t
a v a i l a b l e : n u m b e r ( d o u b l e )
a v a i l a b l e a m o u n t
u p d a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s b a l a n c e w a s l a s t u p d a t e d
E x a m p l e
{
"currencySymbol" : "string" ,
"total" : "number (double)" ,
"available" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
B a t c h O p e r a t i o n
B a s e c l a s s f o r B a t c h o p e r a t i o n r e q u e s t
r e s o u r c e : s t r i n g
O R D E R
r e s o u r c e t y p e f o r b a t c h o p e r a t i o n
o p e r a t i o n : s t r i n g
D E L E T E ,
P O S T
b a t c h o p e r a t i o n t y p e
p a y l o a d : o b j e c t
D e t a i l s f o r t h i s o p e r a t i o n . T y p e v a r i e s d e p e n d i n g o n t h e r e s o u r c e a n d o p e r a t i o n . F o r P O S T o r d e r s e e N e w O r d e r . F o r D E L E T E o r d e r s e e D e l e t e O r d e r
E x a m p l e
{
"resource" : "string" ,
"operation" : "string" ,
"payload" : "object"
}
B a t c h R e s p o n s e
B a s e c l a s s f o r b a t c h r e s p o n s e
s t a t u s : i n t e g e r ( i n t 3 2 )
s t a t u s c o d e o f t h i s b a t c h o p e r a t i o n
p a y l o a d : o b j e c t
D e t a i l e d r e s u l t s f o r t h i s o p e r a t i o n . T y p e v a r i e s d e p e n d i n g o n t h e r e s o u r c e , o p e r a t i o n , a n d w h e t h e r i t w a s s u c c e s s f u l . C u r r e n t l y t h i s w i l l b e e i t h e r a n O r d e r o r a n E r r o r
E x a m p l e
{
"status" : "integer (int32)" ,
"payload" : "object"
}
C o n d i t i o n a l O r d e r
i d : s t r i n g ( u u i d )
u n i q u e I D o f t h i s o r d e r , a s s i g n e d b y t h e s e r v i c e N o t e t h a t t h i s I D i s c o m p l e t e l y u n r e l a t e d t o t h e o p t i o n a l c l i e n t C o n d i t i o n a l O r d e r I d .
m a r k e t S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e m a r k e t t h i s c o n d i t i o n a l o r d e r w i l l b e t r a c k i n g
o p e r a n d : s t r i n g
L T E ,
G T E
p r i c e a b o v e ( G T E ) o r b e l o w ( L T E ) w h i c h t h e c o n d i t i o n a l o r d e r w i l l t r i g g e r T h i s v a l u e w i l l b e s e t a u t o m a t i c a l l y i f t r a i l i n g S t o p P e r c e n t i s s p e c i f i e d . ( e i t h e r t h i s o r t r a i l i n g S t o p P e r c e n t m u s t b e s p e c i f i e d )
t r i g g e r P r i c e : n u m b e r ( d o u b l e )
p e r c e n t a b o v e t h e m i n i m u m p r i c e ( G T E ) o r b e l o w t h e m a x i m u m p r i c e ( L T E ) a t w h i c h t o t r i g g e r ( e i t h e r t h i s o r t r i g g e r P r i c e m u s t b e s p e c i f i e d )
t r a i l i n g S t o p P e r c e n t : n u m b e r ( d o u b l e ) T h e s t o p p r i c e w i l l a u t o m a t i c a l l y a d j u s t r e l a t i v e t o t h e m o s t e x t r e m e t r a d e v a l u e s e e n . ( e i t h e r t h i s o r t r i g g e r p r i c e m u s t b e s p e c i f i e d )
c r e a t e d O r d e r I d : s t r i n g ( u u i d )
u n i q u e I D o f t h e o r d e r t h a t w a s c r e a t e d b y t h i s c o n d i t i o n a l , i f t h e r e i s o n e
o r d e r T o C r e a t e :
N e w O r d e r
o r d e r t o c r e a t e i f t h i s c o n d i t i o n a l o r d e r i s t r i g g e r e d
o r d e r T o C a n c e l :
N e w C a n c e l C o n d i t i o n a l O r d e r o r d e r o r c o n d i t i o n a l o r d e r t o c a n c e l i f t h i s c o n d i t i o n a l o r d e r t r i g g e r s N o t e t h a t t h i s r e l a t i o n s h i p i s r e c i p r o c a l .
c l i e n t C o n d i t i o n a l O r d e r I d : s t r i n g ( u u i d ) c l i e n t - p r o v i d e d i d e n t i f i e r f o r i d e m p o t e n c y ( o p t i o n a l )
s t a t u s : s t r i n g
O P E N ,
C O M P L E T E D ,
C A N C E L L E D ,
F A I L E D c o n d i t i o n a l o r d e r s t a t u s
o r d e r C r e a t i o n E r r o r C o d e : s t r i n g
i f a c o n d i t i o n a l o r d e r f a i l s t o c r e a t e a n o r d e r w h e n t r i g g e r e d , t h e f a i l u r e r e a s o n w i l l a p p e a r h e r e
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) o f o r d e r c r e a t i o n ( a l w a y s p r e s e n t )
u p d a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) o f l a s t o r d e r u p d a t e ( o p t i o n a l )
c l o s e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) w h e n t h i s o r d e r w a s c l o s e d ( o p t i o n a l )
E x a m p l e
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"createdOrderId" : "string (uuid)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)" ,
"status" : "string" ,
"orderCreationErrorCode" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)"
}
N e w O r d e r
m a r k e t S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e m a r k e t t h i s o r d e r i s b e i n g p l a c e d o n
d i r e c t i o n : s t r i n g
B U Y ,
S E L L
o r d e r d i r e c t i o n
t y p e : s t r i n g
L I M I T ,
M A R K E T ,
C E I L I N G _ L I M I T ,
C E I L I N G _ M A R K E T o r d e r t y p e
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y ( o p t i o n a l , m u s t b e i n c l u d e d f o r n o n - c e i l i n g o r d e r s a n d e x c l u d e d f o r c e i l i n g o r d e r s )
c e i l i n g : n u m b e r ( d o u b l e )
c e i l i n g ( o p t i o n a l , m u s t b e i n c l u d e d f o r c e i l i n g o r d e r s a n d e x c l u d e d f o r n o n - c e i l i n g o r d e r s )
l i m i t : n u m b e r ( d o u b l e )
l i m i t ( o p t i o n a l , m u s t b e i n c l u d e d f o r L I M I T o r d e r s a n d e x c l u d e d f o r M A R K E T o r d e r s )
t i m e I n F o r c e : s t r i n g
G O O D _ T I L _ C A N C E L L E D ,
I M M E D I A T E _ O R _ C A N C E L ,
F I L L _ O R _ K I L L ,
P O S T _ O N L Y _ G O O D _ T I L _ C A N C E L L E D ,
B U Y _ N O W ,
I N S T A N T t i m e i n f o r c e
c l i e n t O r d e r I d : s t r i n g ( u u i d )
c l i e n t - p r o v i d e d i d e n t i f i e r f o r a d v a n c e d o r d e r t r a c k i n g ( o p t i o n a l )
u s e A w a r d s : b o o l e a n
o p t i o n t o u s e B i t t r e x c r e d i t s f o r t h e o r d e r ( o p t i o n a l )
E x a m p l e
{
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
}
N e w C a n c e l C o n d i t i o n a l O r d e r
t y p e : s t r i n g
O R D E R ,
C O N D I T I O N A L _ O R D E R t y p e o f o r d e r t o c a n c e l
i d : s t r i n g ( u u i d )
u u i d o f t h e o r d e r o r c o n d i t i o n a l o r d e r t o c a n c e l
E x a m p l e
{
"type" : "string" ,
"id" : "string (uuid)"
}
P a g i n a t i o n P a r a m e t e r s
n e x t P a g e T o k e n : s t r i n g
T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d s t a r t a f t e r , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e f o r w a r d d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f P r e v i o u s P a g e T o k e n i s n o t s p e c i f i e d . )
p r e v i o u s P a g e T o k e n : s t r i n g
T h e u n i q u e i d e n t i f i e r o f t h e i t e m t h a t t h e r e s u l t i n g q u e r y r e s u l t s h o u l d e n d b e f o r e , i n t h e s o r t o r d e r o f t h e g i v e n e n d p o i n t . U s e d f o r t r a v e r s i n g a p a g i n a t e d s e t i n t h e r e v e r s e d i r e c t i o n . ( O p t i o n a l . M a y o n l y b e s p e c i f i e d i f N e x t P a g e T o k e n i s n o t s p e c i f i e d . )
p a g e S i z e : i n t e g e r ( i n t 3 2 )
m a x i m u m n u m b e r o f i t e m s t o r e t r i e v e - - d e f a u l t 1 0 0 , m i n i m u m 1 , m a x i m u m 2 0 0 ( o p t i o n a l )
E x a m p l e
{
"nextPageToken" : "string" ,
"previousPageToken" : "string" ,
"pageSize" : "integer (int32)"
}
D a t e F i l t e r
s t a r t D a t e : s t r i n g ( d a t e - t i m e )
( o p t i o n a l ) F i l t e r s o u t r e s u l t s b e f o r e t h i s t i m e s t a m p . I n I S O 8 6 0 1 f o r m a t ( e . g . , " 2 0 1 9 - 0 1 - 0 2 T 1 6 : 2 3 : 4 5 Z " ) . P r e c i s i o n b e y o n d o n e s e c o n d i s n o t s u p p o r t e d . U s e p a g i n a t i o n p a r a m e t e r s f o r m o r e p r e c i s e f i l t e r i n g .
e n d D a t e : s t r i n g ( d a t e - t i m e )
( o p t i o n a l ) F i l t e r s o u t r e s u l t a f t e r t h i s t i m e s t a m p . U s e s t h e s a m e f o r m a t a s S t a r t D a t e . E i t h e r , b o t h , o r n e i t h e r o f S t a r t D a t e a n d E n d D a t e c a n b e s e t . T h e o n l y c o n s t r a i n t o n t h e p a i r i s t h a t , i f b o t h a r e s e t , t h e n E n d D a t e c a n n o t b e b e f o r e S t a r t D a t e .
E x a m p l e
{
"startDate" : "string (date-time)" ,
"endDate" : "string (date-time)"
}
N e w C o n d i t i o n a l O r d e r
m a r k e t S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e m a r k e t t h i s c o n d i t i o n a l o r d e r w i l l b e t r a c k i n g
o p e r a n d : s t r i n g
L T E ,
G T E
p r i c e a b o v e ( G T E ) o r b e l o w ( L T E ) w h i c h t h e c o n d i t i o n a l o r d e r w i l l t r i g g e r T h i s v a l u e w i l l b e s e t a u t o m a t i c a l l y i f t r a i l i n g S t o p P e r c e n t i s s p e c i f i e d . ( e i t h e r t h i s o r t r a i l i n g S t o p P e r c e n t m u s t b e s p e c i f i e d )
t r i g g e r P r i c e : n u m b e r ( d o u b l e )
p e r c e n t a b o v e t h e m i n i m u m p r i c e ( G T E ) o r b e l o w t h e m a x i m u m p r i c e ( L T E ) a t w h i c h t o t r i g g e r ( e i t h e r t h i s o r t r i g g e r P r i c e m u s t b e s p e c i f i e d )
t r a i l i n g S t o p P e r c e n t : n u m b e r ( d o u b l e ) T h e s t o p p r i c e w i l l a u t o m a t i c a l l y a d j u s t r e l a t i v e t o t h e m o s t e x t r e m e t r a d e v a l u e s e e n . ( e i t h e r t h i s o r t r i g g e r p r i c e m u s t b e s p e c i f i e d )
o r d e r T o C r e a t e :
N e w O r d e r
o r d e r t o c r e a t e i f t h i s c o n d i t i o n a l o r d e r i s t r i g g e r e d
o r d e r T o C a n c e l :
N e w C a n c e l C o n d i t i o n a l O r d e r o r d e r o r c o n d i t i o n a l o r d e r t o c a n c e l i f t h i s c o n d i t i o n a l o r d e r t r i g g e r s N o t e t h a t t h i s r e l a t i o n s h i p i s r e c i p r o c a l .
c l i e n t C o n d i t i o n a l O r d e r I d : s t r i n g ( u u i d ) c l i e n t - p r o v i d e d i d e n t i f i e r f o r i d e m p o t e n c y ( o p t i o n a l )
E x a m p l e
{
"marketSymbol" : "string" ,
"operand" : "string" ,
"triggerPrice" : "number (double)" ,
"trailingStopPercent" : "number (double)" ,
"orderToCreate" : {
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"ceiling" : "number (double)" ,
"limit" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"useAwards" : "boolean"
},
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
},
"clientConditionalOrderId" : "string (uuid)"
}
C u r r e n c y
s y m b o l : s t r i n g
u n i q u e s y m b o l f o r t h i s c u r r e n c y
n a m e : s t r i n g
l o n g n a m e o f t h i s c u r r e n c y
c o i n T y p e : s t r i n g
c o i n t y p e o f t h i s c u r r e n c y
s t a t u s : s t r i n g
O N L I N E ,
O F F L I N E
c u r r e n c y s t a t u s ( o n l i n e , o f f l i n e , e t c . )
m i n C o n f i r m a t i o n s : i n t e g e r ( i n t 3 2 ) m i n i m u m n u m b e r o f c o n f i r m a t i o n s
n o t i c e : s t r i n g
n e w s o r a l e r t s r e g a r d i n g t h i s c u r r e n c y
t x F e e : n u m b e r ( d o u b l e )
t r a n s a c t i o n f e e f o r t h i s c u r r e n c y
l o g o U r l : s t r i n g
u r l t o t h e l o g o i m a g e f o r t h i s c u r r e n c y , i f a v a i l a b l e
p r o h i b i t e d I n : s t r i n g [ ]
l i s t o f p r o h i b i t e d r e g i o n s . e m p t y i f i t s n o t r e s t r i c t e d . N O T E : C u r r e n t l y t h i s f i e l d o n l y i n d i c a t e s i f t h e c u r r e n c y i s p r o h i b i t e d i n t h e U S . W e r e c o m m e n d u s i n g t h e a c c o u n t / p e r m i s s i o n s / c u r r e n c i e s e n d p o i n t i n s t e a d .
b a s e A d d r e s s : s t r i n g
b a s e a d d r e s s f o r t h e c u r r e n c y .
a s s o c i a t e d T e r m s O f S e r v i c e : s t r i n g [ ] l i s t o f a s s o c i a t e d t e r m s o f s e r v i c e .
t a g s : s t r i n g [ ]
m e t a d a t a t a g s f o r t h i s c u r r e n c y
E x a m p l e
{
"symbol" : "string" ,
"name" : "string" ,
"coinType" : "string" ,
"status" : "string" ,
"minConfirmations" : "integer (int32)" ,
"notice" : "string" ,
"txFee" : "number (double)" ,
"logoUrl" : "string" ,
"prohibitedIn" : [
"string"
],
"baseAddress" : "string" ,
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
D e p o s i t
i d : s t r i n g ( u u i d )
u n i q u e I D f o r t h i s d e p o s i t , a s s i g n e d b y t h e s e r v i c e
c u r r e n c y S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e c u r r e n c y b e i n g d e p o s i t e d t o
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y t o d e p o s i t
c r y p t o A d d r e s s : s t r i n g
c r y p t o a d d r e s s f o r t h i s d e p o s i t
f u n d s T r a n s f e r M e t h o d I d : s t r i n g ( u u i d ) P a y m e n t M e t h o d I d
c r y p t o A d d r e s s T a g : s t r i n g
c r y p t o a d d r e s s t a g f o r t h i s d e p o s i t ( o p t i o n a l , d e p e n d s o n t h e c o i n t y p e o f c u r r e n c y b e i n g d e p o s i t e d )
t x I d : s t r i n g
T x I D f o r t h e d e p o s i t ( o p t i o n a l )
c o n f i r m a t i o n s : i n t e g e r ( i n t 3 2 )
c u r r e n t c o u n t o f c o n f i r m a t i o n s
u p d a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s d e p o s i t w a s l a s t u p d a t e d
c o m p l e t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s d e p o s i t w a s c o m p l e t e d ( o p t i o n a l , o n l y s e t w h e n s t a t u s i s C O M P L E T E D )
s t a t u s : s t r i n g
P E N D I N G ,
C O M P L E T E D ,
O R P H A N E D ,
I N V A L I D A T E D c u r r e n t s t a t u s o f t h i s d e p o s i t
s o u r c e : s t r i n g
B L O C K C H A I N ,
W I R E _ T R A N S F E R ,
C R E D I T _ C A R D ,
A C H ,
A I R D R O P s o u r c e o f t h e d e p o s i t
a c c o u n t I d : s t r i n g ( u u i d )
A c c o u n t I d ( o p t i o n a l )
e r r o r :
E r r o r
e r r o r d e t a i l s , p r e s e n t i f a n e r r o r o c c u r r e d d u r i n g p r o c e s s i n g
E x a m p l e
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"cryptoAddressTag" : "string" ,
"txId" : "string" ,
"confirmations" : "integer (int32)" ,
"updatedAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"status" : "string" ,
"source" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
E r r o r
c o d e : s t r i n g
e r r o r c o d e a s s o c i a t e d w i t h t h i s p a r t i c u l a r e r r o r
d e t a i l : s t r i n g
a d d i t i o n a l i n f o r m a t i o n d e s c r i b i n g t h e e r r o r a n d / o r t h e i n c l u d e d d a t a ( o p t i o n a l )
d a t a : o b j e c t
a s e t o f k e y - v a l u e p a i r s c o n t a i n i n g d a t a r e l e v a n t t o t h i s p a r t i c u l a r e r r o r ( o p t i o n a l )
E x a m p l e
{
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
E x e c u t i o n
i d : s t r i n g ( u u i d )
u n i q u e I D o f t h i s e x e c u t i o n , a s s i g n e d b y t h e s e r v i c e
m a r k e t S y m b o l : s t r i n g
m a r k e t s y m b o l w h e r e t h i s e x e c u t i o n t o o k p l a c e
e x e c u t e d A t : s t r i n g ( d a t e - t i m e )
t i m e w h e n t h e e x e c u t i o n w a s p r o c e s s e d
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y t r a d e d d u r i n g t h i s e x e c u t i o n
r a t e : n u m b e r ( d o u b l e )
r a t e a t w h i c h t h i s t r a d e w a s e x e c u t e d
o r d e r I d : s t r i n g ( u u i d )
o r d e r I D a s s o c i a t e d w i t h t h i s e x e c u t i o n
c o m m i s s i o n : n u m b e r ( d o u b l e )
c o m m i s s i o n c h a r g e d f o r t h i s e x e c u t i o n
i s T a k e r : b o o l e a n
t r u e i f t h e o r d e r I D s p e c i f i e d w a s t h e t a k e r f o r t h i s e x e c u t i o n , o t h e r w i s e f a l s e
E x a m p l e
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"orderId" : "string (uuid)" ,
"commission" : "number (double)" ,
"isTaker" : "boolean"
}
E x e c u t i o n L a s t I d
l a s t I d : s t r i n g ( u u i d )
l a s t e x e c u t i o n i d f o r t h e u s e r
E x a m p l e
{
"lastId" : "string (uuid)"
}
F u n d s T r a n s f e r M e t h o d
i d : s t r i n g ( u u i d )
U n i q u e i d e n t i f i e r o f t h i s f u n d s t r a n s f e r m e t h o d
f r i e n d l y N a m e : s t r i n g
F r i e n d l y d e s c r i p t i o n o f t h i s f u n d s t r a n s f e r m e t h o d
b a n k N a m e : s t r i n g
N a m e o f t h e b a n k a s s o c i a t e d w i t h t h i s f u n d s t r a n s f e r m e t h o d
a c c o u n t N u m b e r : s t r i n g
L a s t 4 d i g i t s o f a c c o u n t n u m b e r ( o n l y a v a i l a b l e f o r A C H f u n d s t r a n s f e r m e t h o d s )
s t a t e : s t r i n g
D I S A B L E D ,
E N A B L E D ,
D E L E T E D ,
P E N D I N G ,
V E R I F I C A T I O N _ R E Q U I R E D ,
V A L I D A T I O N _ F A I L E D S t a t e o f t h i s f u n d s t r a n s f e r m e t h o d
t y p e : s t r i n g
W I R E ,
S E P A ,
I N S T A N T _ S E T T L E M E N T ,
A C H ,
S E N F i a t t r a n s f e r t y p e
d e p o s i t O n l y : b o o l e a n
I n d i c a t e s i f w i t h d r a w a l s a r e a l l o w e d v i a t h i s f u n d s t r a n s f e r m e t h o d
E x a m p l e
{
"id" : "string (uuid)" ,
"friendlyName" : "string" ,
"bankName" : "string" ,
"accountNumber" : "string" ,
"state" : "string" ,
"type" : "string" ,
"depositOnly" : "boolean"
}
M a r k e t
s y m b o l : s t r i n g
u n i q u e s y m b o l f o r t h i s m a r k e t
b a s e C u r r e n c y S y m b o l : s t r i n g
u n i q u e s y m b o l f o r b a s e c u r r e n c y
q u o t e C u r r e n c y S y m b o l : s t r i n g
u n i q u e s y m b o l f o r q u o t e c u r r e n c y
m i n T r a d e S i z e : n u m b e r ( d o u b l e )
m i n i m u m t r a d e s i z e
p r e c i s i o n : i n t e g e r ( i n t 3 2 )
m a x i m u m a l l o w e d p r e c i s i o n f o r t h e l i m i t p r i c e o n a n o r d e r
s t a t u s : s t r i n g
O N L I N E ,
O F F L I N E
t r u e i f t h i s m a r k e t i s c u r r e n t l y a c t i v e
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p i n U T C w h e n t h i s m a r k e t w a s c r e a t e d
n o t i c e : s t r i n g
n o t i c e o r a l e r t i n f o
p r o h i b i t e d I n : s t r i n g [ ]
l i s t o f p r o h i b i t e d r e g i o n s . e m p t y i f i t s n o t r e s t r i c t e d . N O T E : C u r r e n t l y t h i s f i e l d o n l y i n d i c a t e s i f t h e m a r k e t i s p r o h i b i t e d i n t h e U S . W e r e c o m m e n d u s i n g t h e a c c o u n t / p e r m i s s i o n s / m a r k e t s e n d p o i n t i n s t e a d .
a s s o c i a t e d T e r m s O f S e r v i c e : s t r i n g [ ] l i s t o f a s s o c i a t e d t e r m s o f s e r v i c e .
t a g s : s t r i n g [ ]
m e t a d a t a t a g s f o r t h i s m a r k e t
E x a m p l e
{
"symbol" : "string" ,
"baseCurrencySymbol" : "string" ,
"quoteCurrencySymbol" : "string" ,
"minTradeSize" : "number (double)" ,
"precision" : "integer (int32)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"notice" : "string" ,
"prohibitedIn" : [
"string"
],
"associatedTermsOfService" : [
"string"
],
"tags" : [
"string"
]
}
M a r k e t S u m m a r y
s y m b o l : s t r i n g
u n i q u e s y m b o l f o r t h i s m a r k e t
h i g h : n u m b e r ( d o u b l e )
h i g h e s t p r i c e o f a t r a d e t h a t o c c u r r e d w i t h i n t h e l a s t 2 4 h o u r s ( o r z e r o i f t h e r e w e r e n o t r a d e s )
l o w : n u m b e r ( d o u b l e )
l o w e s t p r i c e o f a t r a d e t h a t o c c u r r e d w i t h i n t h e l a s t 2 4 h o u r s ( o r z e r o i f t h e r e w e r e n o t r a d e s )
v o l u m e : n u m b e r ( d o u b l e )
v o l u m e w i t h i n t h e l a s t 2 4 h o u r s
q u o t e V o l u m e : n u m b e r ( d o u b l e )
q u o t e v o l u m e w i t h i n t h e l a s t 2 4 h o u r s
p e r c e n t C h a n g e : n u m b e r ( d o u b l e )
p e r c e n t a g e c h a n g e o f t h e e x c h a n g e r a t e o v e r t h e l a s t 2 4 h o u r s ( p o s i t i v e o r n e g a t i v e )
u p d a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p i n U T C w h e n m a r k e t s u m m a r y w a s l a s t u p d a t e d
E x a m p l e
{
"symbol" : "string" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)" ,
"percentChange" : "number (double)" ,
"updatedAt" : "string (date-time)"
}
T i c k e r
s y m b o l : s t r i n g
u n i q u e s y m b o l f o r t h i s m a r k e t
l a s t T r a d e R a t e : n u m b e r ( d o u b l e )
p r i c e o f t h e l a s t t r a d e ( o r z e r o i f t h e r e w e r e n o t r a d e s )
b i d R a t e : n u m b e r ( d o u b l e )
r a t e o f t h e c u r r e n t b e s t b i d ( o r z e r o i f t h e r e a r e n o b i d s )
a s k R a t e : n u m b e r ( d o u b l e )
r a t e o f t h e c u r r e n t b e s t a s k ( o r z e r o i f t h e r e a r e n o a s k s )
E x a m p l e
{
"symbol" : "string" ,
"lastTradeRate" : "number (double)" ,
"bidRate" : "number (double)" ,
"askRate" : "number (double)"
}
O r d e r B o o k
b i d :
O r d e r B o o k E n t r y
b u y e n t r i e s
a s k :
O r d e r B o o k E n t r y
s e l l e n t r i e s
E x a m p l e
{
"bid" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
],
"ask" : [
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
]
}
O r d e r B o o k E n t r y
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y
r a t e : n u m b e r ( d o u b l e )
r a t e
E x a m p l e
{
"quantity" : "number (double)" ,
"rate" : "number (double)"
}
T r a d e
i d : s t r i n g ( u u i d )
u n i q u e I D o f t h i s t r a d e , a s s i g n e d b y t h e s e r v i c e ( a l w a y s p r e s e n t )
e x e c u t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p i n U T C w h e n o r d e r w a s f i l l e d
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y
r a t e : n u m b e r ( d o u b l e )
r a t e
t a k e r S i d e : s t r i n g
B U Y ,
S E L L
t a k e r s i d e ( s p e c i f i e s w h e t h e r t h e t a k e r w a s t h e b u y o r s e l l s i d e )
E x a m p l e
{
"id" : "string (uuid)" ,
"executedAt" : "string (date-time)" ,
"quantity" : "number (double)" ,
"rate" : "number (double)" ,
"takerSide" : "string"
}
C a n d l e
s t a r t s A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p i n U T C f o r w h e n t h i s c a n d l e ' s t i m e i n t e r v a l s t a r t s
o p e n : n u m b e r ( d o u b l e )
o p e n
h i g h : n u m b e r ( d o u b l e )
h i g h
l o w : n u m b e r ( d o u b l e )
l o w
c l o s e : n u m b e r ( d o u b l e )
c l o s e
v o l u m e : n u m b e r ( d o u b l e )
v o l u m e
q u o t e V o l u m e : n u m b e r ( d o u b l e )
q u o u t e v o l u m e
E x a m p l e
{
"startsAt" : "string (date-time)" ,
"open" : "number (double)" ,
"high" : "number (double)" ,
"low" : "number (double)" ,
"close" : "number (double)" ,
"volume" : "number (double)" ,
"quoteVolume" : "number (double)"
}
O r d e r
i d : s t r i n g ( u u i d )
u n i q u e I D o f t h i s o r d e r , a s s i g n e d b y t h e s e r v i c e ( a l w a y s p r e s e n t ) N o t e t h a t t h i s I D i s c o m p l e t e l y u n r e l a t e d t o t h e o p t i o n a l C l i e n t O r d e r I d .
m a r k e t S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e m a r k e t t h i s o r d e r i s b e i n g p l a c e d o n ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w O r d e r )
d i r e c t i o n : s t r i n g
B U Y ,
S E L L
o r d e r d i r e c t i o n ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w O r d e r )
t y p e : s t r i n g
L I M I T ,
M A R K E T ,
C E I L I N G _ L I M I T ,
C E I L I N G _ M A R K E T o r d e r t y p e ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w O r d e r )
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y ( o p t i o n a l , m a t c h e s t h e f i e l d i n N e w O r d e r )
l i m i t : n u m b e r ( d o u b l e )
l i m i t p r i c e ( o p t i o n a l , m a t c h e s t h e f i e l d i n N e w O r d e r )
c e i l i n g : n u m b e r ( d o u b l e )
c e i l i n g ( o p t i o n a l , m a t c h e s t h e f i e l d i n N e w O r d e r )
t i m e I n F o r c e : s t r i n g
G O O D _ T I L _ C A N C E L L E D ,
I M M E D I A T E _ O R _ C A N C E L ,
F I L L _ O R _ K I L L ,
P O S T _ O N L Y _ G O O D _ T I L _ C A N C E L L E D ,
B U Y _ N O W ,
I N S T A N T t i m e i n f o r c e ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w O r d e r )
c l i e n t O r d e r I d : s t r i n g ( u u i d )
c l i e n t - p r o v i d e d i d e n t i f i e r f o r a d v a n c e d o r d e r t r a c k i n g ( o p t i o n a l , m a t c h e s t h e f i e l d i n N e w O r d e r )
f i l l Q u a n t i t y : n u m b e r ( d o u b l e )
Q u a n t i t y f i l l e d i n b a s e c u r r e n c y ( e . g . B T C o n t h e B T C / U S D m a r k e t )
c o m m i s s i o n : n u m b e r ( d o u b l e )
C o m m i s s i o n p a i d o n t h e o r d e r i n q u o t e c u r r e n c y ( e . g . U S D o n t h e B T C / U S D m a r k e t )
p r o c e e d s : n u m b e r ( d o u b l e )
A m o u n t p a i d f o r b u y o r d e r s o r a m o u n t r e c e i v e d f o r s e l l o r d e r s i n q u o t e c u r r e n c y ( e . g . U S D o n t h e B T C / U S D m a r k e t ) . A v e r a g e f i l l p r i c e i s p r o c e e d s / q u a n t i t y F i l l e d . T h e t o t a l q u o t e c u r r e n c y p a i d f o r a b u y o r d e r i s p r o c e e d s + c o m m i s s i o n . F o r a s e l l o r d e r t h e q u o t e c u r r e n c y r e c e i v e d i s p r o c e e d s - c o m m i s s i o n
s t a t u s : s t r i n g
O P E N ,
C L O S E D
o r d e r s t a t u s ( a l w a y s p r e s e n t )
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) o f o r d e r c r e a t i o n ( a l w a y s p r e s e n t )
u p d a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) o f l a s t o r d e r u p d a t e ( o p t i o n a l )
c l o s e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p ( U T C ) w h e n t h i s o r d e r w a s c l o s e d ( o p t i o n a l )
o r d e r T o C a n c e l :
N e w C a n c e l C o n d i t i o n a l O r d e r c o n d i t i o n a l o r d e r t o c a n c e l i f t h i s o r d e r e x e c u t e s N o t e t h a t t h i s r e l a t i o n s h i p i s r e c i p r o c a l .
E x a m p l e
{
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
B u l k C a n c e l R e s u l t
i d : s t r i n g ( u u i d )
s t a t u s C o d e : s t r i n g
r e s u l t :
O r d e r
E x a m p l e
{
"id" : "string (uuid)" ,
"statusCode" : "string" ,
"result" : {
"id" : "string (uuid)" ,
"marketSymbol" : "string" ,
"direction" : "string" ,
"type" : "string" ,
"quantity" : "number (double)" ,
"limit" : "number (double)" ,
"ceiling" : "number (double)" ,
"timeInForce" : "string" ,
"clientOrderId" : "string (uuid)" ,
"fillQuantity" : "number (double)" ,
"commission" : "number (double)" ,
"proceeds" : "number (double)" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"updatedAt" : "string (date-time)" ,
"closedAt" : "string (date-time)" ,
"orderToCancel" : {
"type" : "string" ,
"id" : "string (uuid)"
}
}
}
S e r v i c e P i n g
s e r v e r T i m e : i n t e g e r ( i n t 6 4 )
S e r v e r t i m e i n e p o c h m i l l i s e c o n d f o r m a t , r o u n d e d d o w n t o t h e n e a r e s t s e c o n d . T h e s a m e f o r m a t m u s t b e u s e d i n t h e A p i - T i m e s t a m p h e a d e r o f a u t h e n t i c a t e d r e q u e s t s .
E x a m p l e
{
"serverTime" : "integer (int64)"
}
S u b a c c o u n t
i d : s t r i n g ( u u i d )
u n i q u e I D o f t h i s s u b a c c o u n t
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s s u b a c c o u n t w a s c r e a t e d
E x a m p l e
{
"id" : "string (uuid)" ,
"createdAt" : "string (date-time)"
}
N e w S u b a c c o u n t
E x a m p l e
{}
W i t h d r a w a l
i d : s t r i n g ( u u i d )
u n i q u e I D f o r t h i s w i t h d r a w a l , a s s i g n e d b y t h e s e r v i c e ( a l w a y s p r e s e n t )
c u r r e n c y S y m b o l : s t r i n g
u n i q u e s y m b o l o f c u r r e n c y t o w i t h d r a w ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w W i t h d r a w a l )
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y t o w i t h d r a w ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w W i t h d r a w a l )
c r y p t o A d d r e s s : s t r i n g
c r y p t o a d d r e s s f o r t h i s w i t h d r a w a l ( a l w a y s p r e s e n t , m a t c h e s t h e f i e l d i n N e w W i t h d r a w a l )
c r y p t o A d d r e s s T a g : s t r i n g
c u s t o m m e s s a g e f u r t h e r s p e c i f y i n g h o w t o c o m p l e t e t h e w i t h d r a w a l ( o p t i o n a l , m a t c h e s t h e f i e l d i n N e w W i t h d r a w a l )
f u n d s T r a n s f e r M e t h o d I d : s t r i n g ( u u i d ) u n i q u e I D f o r t h e f u n d s t r a n s f e r m e t h o d ( i . e . b a n k a c c o u n t ) u s e d a s a d e s t i n a t i o n f o r t h i s w i t h d r a w a l
t x C o s t : n u m b e r ( d o u b l e )
T x C o s t o f t h i s w i t h d r a w a l ( a l w a y s p r e s e n t )
t x I d : s t r i n g
T x I D a s s o c i a t e d w i t h t h i s w i t h d r a w a l ( o p t i o n a l )
s t a t u s : s t r i n g
R E Q U E S T E D ,
A U T H O R I Z E D ,
P E N D I N G ,
C O M P L E T E D ,
E R R O R _ I N V A L I D _ A D D R E S S ,
C A N C E L L E D ,
N E W c u r r e n t s t a t u s o f t h i s w i t h d r a w a l ( a l w a y s p r e s e n t )
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s w i t h d r a w a l w a s i n i t i a t e d ( a l w a y s p r e s e n t )
c o m p l e t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s w i t h d r a w a l w a s c o m p l e t e d ( o p t i o n a l )
c l i e n t W i t h d r a w a l I d : s t r i n g ( u u i d ) c l i e n t - p r o v i d e d i d e n t i f i e r f o r i d e m p o t e n c y ( o p t i o n a l )
t a r g e t : s t r i n g
B L O C K C H A I N ,
W I R E _ T R A N S F E R ,
C R E D I T _ C A R D ,
A C H t a r g e t o f t h e w i t h d r a w a l
a c c o u n t I d : s t r i n g ( u u i d )
A c c o u n t I d ( o p t i o n a l )
e r r o r :
E r r o r
e r r o r d e t a i l s , p r e s e n t i f a n e r r o r o c c u r r e d d u r i n g p r o c e s s i n g
E x a m p l e
{
"id" : "string (uuid)" ,
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"txCost" : "number (double)" ,
"txId" : "string" ,
"status" : "string" ,
"createdAt" : "string (date-time)" ,
"completedAt" : "string (date-time)" ,
"clientWithdrawalId" : "string (uuid)" ,
"target" : "string" ,
"accountId" : "string (uuid)" ,
"error" : {
"code" : "string" ,
"detail" : "string" ,
"data" : "object"
}
}
S e n t T r a n s f e r I n f o
t o S u b a c c o u n t I d : s t r i n g ( u u i d )
r e c e i v e r a c c o u n t I D
t o M a s t e r A c c o u n t : b o o l e a n
t r a n s f e r t o m a s t e r a c c o u n t
i d : s t r i n g ( u u i d )
u n i q u e I D f o r t h i s t r a n s f e r
r e q u e s t I d : s t r i n g ( u u i d )
c l i e n t t r a n s f e r i d
c u r r e n c y S y m b o l : s t r i n g
c u r r e n c y s y m b o l t r a n s f e r e d
a m o u n t : n u m b e r ( d o u b l e )
a m o u n t t r a n s f e r e d
e x e c u t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s t r a n s f e r w a s e x e c u t e d
E x a m p l e
{
"toSubaccountId" : "string (uuid)" ,
"toMasterAccount" : "boolean" ,
"id" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"executedAt" : "string (date-time)"
}
R e c e i v e d T r a n s f e r I n f o
f r o m S u b a c c o u n t I d : s t r i n g ( u u i d )
s e n d e r a c c o u n t I D
f r o m M a s t e r A c c o u n t : b o o l e a n
t r a n s f e r f r o m m a s t e r a c c o u n t
i d : s t r i n g ( u u i d )
u n i q u e I D f o r t h i s t r a n s f e r
r e q u e s t I d : s t r i n g ( u u i d )
c l i e n t t r a n s f e r i d
c u r r e n c y S y m b o l : s t r i n g
c u r r e n c y s y m b o l t r a n s f e r e d
a m o u n t : n u m b e r ( d o u b l e )
a m o u n t t r a n s f e r e d
e x e c u t e d A t : s t r i n g ( d a t e - t i m e )
t i m e s t a m p w h e n t h i s t r a n s f e r w a s e x e c u t e d
E x a m p l e
{
"fromSubaccountId" : "string (uuid)" ,
"fromMasterAccount" : "boolean" ,
"id" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"executedAt" : "string (date-time)"
}
N e w T r a n s f e r
t o S u b a c c o u n t I d : s t r i n g ( u u i d )
r e c e i v e r a c c o u n t I D
r e q u e s t I d : s t r i n g ( u u i d )
c l i e n t t r a n s f e r i d
c u r r e n c y S y m b o l : s t r i n g
c u r r e n c y s y m b o l t r a n s f e r e d
a m o u n t : n u m b e r ( d o u b l e )
a m o u n t t r a n s f e r e d
t o M a s t e r A c c o u n t : b o o l e a n
t r a n s f e r t o m a s t e r a c c o u n t
E x a m p l e
{
"toSubaccountId" : "string (uuid)" ,
"requestId" : "string (uuid)" ,
"currencySymbol" : "string" ,
"amount" : "number (double)" ,
"toMasterAccount" : "boolean"
}
N e w W i t h d r a w a l
c u r r e n c y S y m b o l : s t r i n g
u n i q u e s y m b o l o f t h e c u r r e n c y t o w i t h d r a w f r o m
q u a n t i t y : n u m b e r ( d o u b l e )
q u a n t i t y t o w i t h d r a w
c r y p t o A d d r e s s : s t r i n g
c r y p t o a d d r e s s t o w i t h d r a w f u n d s t o
c r y p t o A d d r e s s T a g : s t r i n g
c u s t o m m e s s a g e f u r t h e r s p e c i f y i n g h o w t o c o m p l e t e t h e w i t h d r a w a l ( o p t i o n a l , d e p e n d s o n w h e t h e r t h e c r y p t o A d d r e s s i s s u f f i c i e n t f o r t h i s c u r r e n c y )
f u n d s T r a n s f e r M e t h o d I d : s t r i n g ( u u i d ) u n i q u e I D f o r t h e f u n d s t r a n s f e r m e t h o d ( i . e . b a n k a c c o u n t ) u s e d a s a d e s t i n a t i o n f o r t h i s w i t h d r a w a l
c l i e n t W i t h d r a w a l I d : s t r i n g ( u u i d ) c l i e n t - p r o v i d e d i d e n t i f i e r f o r i d e m p o t e n c y ( o p t i o n a l )
E x a m p l e
{
"currencySymbol" : "string" ,
"quantity" : "number (double)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string" ,
"fundsTransferMethodId" : "string (uuid)" ,
"clientWithdrawalId" : "string (uuid)"
}
A l l o w e d A d d r e s s
c u r r e n c y S y m b o l : s t r i n g
t h e u n i q u e I D o f t h e c u r r e n c y f o r t h i s w i t h d r a w a l a l l o w e d a d d r e s s
c r e a t e d A t : s t r i n g ( d a t e - t i m e )
d a t e a n d t i m e t h i s a d d r e s s w a s a d d e d t o t h e a l l o w e d l i s t
s t a t u s : s t r i n g
A C T I V E ,
P E N D I N G
w h e t h e r t h i s a d d r e s s m a y c u r r e n t l y b e u s e d f o r w i t h d r a w a l s o r i s p e n d i n g t h e w a i t i n g p e r i o d
a c t i v e A t : s t r i n g ( d a t e - t i m e )
d a t e a n d t i m e a f t e r w h i c h t h i s a d d r e s s m a y b e u s e d f o r w i t h d r a w a l s
c r y p t o A d d r e s s : s t r i n g
t h e c r y p t o g r a p h i c a d d r e s s t h a t i s a l l o w e d f o r w i t h d r a w a l s
c r y p t o A d d r e s s T a g : s t r i n g
t h e c r y p t o g r a p h i c a d d r e s s t a g t h a t i s a l l o w e d f o r w i t h d r a w a l s ( o p t i o n a l )
E x a m p l e
{
"currencySymbol" : "string" ,
"createdAt" : "string (date-time)" ,
"status" : "string" ,
"activeAt" : "string (date-time)" ,
"cryptoAddress" : "string" ,
"cryptoAddressTag" : "string"
}
D e l e t e O r d e r
P a y l o a d f o r c a n c e l l i n g a n e x i s t i n g o r d e r
i d : s t r i n g ( u u i d )
o r d e r I d t o b e c a n c e l l e d .
E x a m p l e
{
"id" : "string (uuid)"
}
S o c k e t R e s p o n s e
S u c c e s s : b o o l e a n
t r u e i f t h e o p e r a t i o n w a s s u c c e s s f u l , f a l s e o t h e r w i s e
E r r o r C o d e : s t r i n g
f a i l u r e r e a s o n
E x a m p l e
{
"Success" : "boolean" ,
"ErrorCode" : "string"
}
API Reference
v1.1
v3
v3
●v1.1EOL
●v3
How-To Guide: Upgrading to v3
