-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathschema.graphql
3780 lines (3214 loc) · 71.7 KB
/
schema.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
schema {
query: RootQueryType
mutation: RootMutationType
subscription: RootSubscriptionType
}
type AccountAddress {
address: String
currency: CurrencySymbol
vins: [Vin]
}
"""
Account balances in a given currency
"""
type AccountBalance {
asset: Asset
available: CurrencyAmount
depositAddress: String
inOrders: CurrencyAmount
pending: CurrencyAmount
personal: CurrencyAmount
}
type AccountDepositAddress {
address: String
currency: CurrencySymbol
vins: [Vin]
}
type AccountPortfolio {
balances: [AccountPortfolioBalance]
graph: [GraphPoint]
total: AccountPortfolioTotal
"""
Total active staked tokens
"""
totalStakedTokens: CurrencyAmount
}
type AccountPortfolioBalance {
allocation: Float
asset: Asset
fiatPrice: Float
fiatPriceChange: Float
fiatPriceChangePercent: Float
total: Float
totalFiatPrice: Float
totalFiatPriceChange: Float
}
type AccountPortfolioTotal {
availableAllocation: Float
availableFiatPrice: Float
inOrdersAllocation: Float
inOrdersFiatPrice: Float
inStakesAllocation: Float
inStakesFiatPrice: Float
pendingAllocation: Float
pendingFiatPrice: Float
personalAllocation: Float
personalFiatPrice: Float
totalFiatPrice: Float
totalFiatPriceChange: Float
totalFiatPriceChangePercent: Float
}
type AccountResponse {
company: CompanyResponse
creatingAccount: Boolean!
email: String!
encryptedSecretKey: String
encryptedSecretKeyNonce: String
encryptedSecretKeyTag: String
id: ID!
identity: IdentityResponse
insertedAt: NaiveDateTime!
isDuplicate: Boolean!
loginErrorCount: Int!
merchant: Boolean
mpcKey: String
options: Options
settings: Json
signaturePublicKey: Base16
twoFactor: Boolean!
twoFactorErrorCount: String!
verified: Boolean!
wallets: [Wallet!]
}
type AccountSecrets {
encryptedSecretKey: String
encryptedSecretKeyNonce: String
encryptedSecretKeyTag: String
}
type AccountStake {
estimatedNextPayment: DateTime
id: ID!
returnRate: Float!
stakedTokens: CurrencyAmount!
stakeId: String
start: Date!
status: StakeStatus!
stop: Date!
totalDividends: CurrencyAmount!
}
type AccountStakes {
stakes: [AccountStake!]!
"""
Total dividends received all time
"""
totalDividends: CurrencyAmount!
"""
Total active staked tokens
"""
totalStakedTokens: CurrencyAmount!
}
type AccountStakingDividend {
asset: Asset!
assetName: String!
dividend: CurrencyAmount!
id: ID!
paidAt: DateTime!
returnRate: Int!
totalStaked: CurrencyAmount!
usdDividend: CurrencyAmount!
}
type AccountStakingDividends {
dividends: [AccountStakingDividend!]!
paidDaysThisMonth: Int!
stakesCompleted: Int!
stakesInProgress: Int!
totalDividends: CurrencyAmount!
}
type AccountStakingStatement {
activeStakes: Int!
id: ID!
month: Int!
totalDividends: CurrencyAmount!
year: Int!
}
enum AccountTradeSide {
"""
The requesting account was the maker in this trade
"""
MAKER
"""
The requesting account played no role in this trade
"""
NONE
"""
The requesting account was the taker in this trade
"""
TAKER
}
type AccountTransaction {
address: String
blockchain: String
blockDatetime: String
blockIndex: Int
confirmations: Confirmations
contact: Contact
fees: CurrencyAmount!
fiatValue: Float
status: String
txid: String
type: String
value: CurrencyAmount
}
"""
Account transfer
"""
type AccountTransfer {
address: String!
id: String!
logicalTimestamp: DateTime!
quote: FiatRampQuote
type: TransferType!
value: CurrencyAmount!
}
type AccountVolume {
"""
Volumes for the current calendar day
"""
daily: AccountVolumePeriod
"""
Estimated maker trade fee rate based on 30 day volume
"""
makerFeeRate: Float
"""
Volumes for the last 30 calendar days - including today
"""
monthly: AccountVolumePeriod
"""
Estimated taker trade fee rate based on 30 day volume
"""
takerFeeRate: Float
"""
Volume for the last 365 calendar days - including today
"""
yearly: AccountVolumePeriod
}
type AccountVolumePeriod {
"""
Spend limit for given period
"""
accountLimit: CurrencyAmount
"""
Volume plus open order amounts
"""
accountSpend: CurrencyAmount
"""
Volume from executed trades during period
"""
accountVolume: CurrencyAmount
"""
Total volume on the exchange
"""
exchangeVolume: CurrencyAmount
}
type Activity {
browser: String!
city: String
countryCode: String!
insertedAt: DateTime!
ipAddress: ip_address!
platform: String!
status: String!
type: String!
}
type ActivitySummaryResponse {
allTimePaidPayout: CurrencyAmount!
allTimeRevenue: CurrencyAmount!
dailyRevenue: CurrencyAmount!
dailyTransactionCount: Int!
nextScheduledPayout: DateTime!
paidPayoutCount: Int!
revenueWaitingPayout: CurrencyAmount!
}
input AddMovementParams {
address: String!
nonce: Int!
quantity: CurrencyAmountParams!
resignedOrders: [ClientSignedMessage]
signedTransactionElements: [ClientSignedMessage]
targetAddress: String
"""
When the request was generated - integer timestamp in milliseconds
"""
timestamp: Int!
transactionHash: Base16
transactionPayload: Base16
type: MovementType!
}
type AddressResponse {
city: String!
country: String!
fullAddress: String!
roadAddress: String!
state: String
zipCode: String!
}
type AffiliateAssetPayment {
asset: Asset
"""
sum referral and developer commission
"""
commission: CurrencyAmount!
"""
sum referral and developer commission usd
"""
commissionUsd: CurrencyAmount!
"""
The payout you received for the developer fees collected based on your tier
"""
developerCommission: CurrencyAmount!
"""
total approximate usd value of the developer payout
"""
developerCommissionUsd: CurrencyAmount!
"""
the volume of the fees collected on developer qualified volume
"""
developerFeesCollected: CurrencyAmount!
"""
usd value of the developer fee volume as calculated during payout
"""
developerFeesCollectedUsd: CurrencyAmount!
"""
the volume of the trades for which your developer code was attached
"""
developerQualifyingVolume: CurrencyAmount!
"""
usd value of the developer qualifying volume as calculated during payout
"""
developerQualifyingVolumeUsd: CurrencyAmount!
"""
sum referral and developer fees collected
"""
feesCollected: CurrencyAmount!
"""
sum referral and developer fees collected usd
"""
feesCollectedUsd: CurrencyAmount!
id: ID!
"""
sum referral and developer qualifying volume
"""
qualifyingVolume: CurrencyAmount!
"""
sum referral and developet qualifying volume usd
"""
qualifyingVolumeUsd: CurrencyAmount!
"""
The payout you received for the referral fees collected based on your tier
"""
referralCommission: CurrencyAmount!
"""
total approximate usd value of the referral payout
"""
referralCommissionUsd: CurrencyAmount!
"""
the volume of the fees collected on qualified referral volume
"""
referralFeesCollected: CurrencyAmount!
"""
usd value of the referral fee volume as calculated during payout
"""
referralFeesCollectedUsd: CurrencyAmount!
"""
the volume of the trades for which your affiliate/referral code was used
"""
referralQualifyingVolume: CurrencyAmount!
"""
usd value of the qualifying volume of referred accounts
"""
referralQualifyingVolumeUsd: CurrencyAmount!
}
"""
Optional code attached to orders by developer enrolled in the Nash Affiliate Program.
Based on the referral code and and optional label, joined with a colon.
Label may only contain alpha numeric characters.
Accepts referral_code:optional_label
"""
scalar AffiliateDeveloperCode
type AffiliateLabelVolume {
"""
the portion of this period's commission attributed to this label
"""
commissionPortionPercent: Int!
"""
total approximate usd value of the payout for this label
"""
commissionUsd: CurrencyAmount!
id: ID!
"""
the date the fees were collected
"""
label: String
"""
usd value of the qualifying volume for the label as calculated during payout
"""
qualifyingVolumeUsd: CurrencyAmount!
}
type AffiliateLabelVolumePage {
"""
list of label and their associated volumes/payouts
"""
labelVolumes: [AffiliateLabelVolume]!
"""
Month this page of label volume data represents
"""
month: Int!
"""
Year this page of label volume data convers
"""
year: Int!
}
type AffiliatePayout {
"""
sum developer and referral daily commission
"""
dailyCommissionUsd: CurrencyAmount!
"""
total approximate usd value of the commission paid on developer fees collected
"""
dailyDeveloperCommissionUsd: CurrencyAmount!
"""
usd value of the fees collected on developer qualifying volume
"""
dailyDeveloperFeesCollectedUsd: CurrencyAmount!
"""
usd value of the qualifying volume generated by orders placed including your developer code
"""
dailyDeveloperQualifyingVolumeUsd: CurrencyAmount!
"""
sum developer and referral fees collected
"""
dailyFeesCollectedUsd: CurrencyAmount!
"""
sum developer and referral qualifying volume
"""
dailyQualifyingVolumeUsd: CurrencyAmount!
"""
total approximate usd value of the commission paid on referral fees collected
"""
dailyReferralCommissionUsd: CurrencyAmount!
"""
usd value of the fees collected on referral qualifying volume
"""
dailyReferralFeesCollectedUsd: CurrencyAmount!
"""
usd value of the qualifying volume generated by referred users
"""
dailyReferralQualifyingVolumeUsd: CurrencyAmount!
"""
the percentage of daily developer fees collected you receive
"""
developerCommissionPercent: Int!
id: ID!
"""
the list of per asset payments sent you your account
"""
payments: [AffiliateAssetPayment]!
"""
the date the fees were collected
"""
payoutFor: Date
"""
the percentage of daily referral fees collected you receive
"""
referralCommissionPercent: Int!
}
type AffiliatePayoutPage {
"""
Month this page of payouts represents
"""
month: Int!
"""
list of daily affiliate payouts
"""
payouts: [AffiliatePayout]!
"""
Year this page of payouts convers
"""
year: Int!
}
type AffiliateStatement {
"""
Sum of developer and referral commission
"""
commissionUsd: CurrencyAmount!
"""
total approximate usd value of the commission earned on developer qualifying volume in this statement period
"""
developerCommissionUsd: CurrencyAmount!
"""
total approximate usd value of the volume generated by attaching a developer code to orders in this statement period
"""
developerQualifyingVolumeUsd: CurrencyAmount!
hasDeveloperVolume: Boolean!
id: ID!
"""
statement month
"""
month: Int!
"""
Sum of developer and referral qualifying volume
"""
qualifyingVolumeUsd: CurrencyAmount!
"""
total approximate usd value of the commission earned on referral qualifying volume in this statement period
"""
referralCommissionUsd: CurrencyAmount!
"""
total approximate usd value of the volume generated by referred users in this period
"""
referralQualifyingVolumeUsd: CurrencyAmount!
"""
statement year
"""
year: Int!
}
type AffiliateStatementPage {
"""
Sum of all time developer and referral commission paid
"""
allTimeCommissionUsd: CurrencyAmount!
"""
Total commission paid on all time developer generated qualifying volume
"""
allTimeDeveloperCommissionUsd: CurrencyAmount!
"""
Total commission paid on all time referral qualifying volume
"""
allTimeReferralCommissionUsd: CurrencyAmount!
"""
Your current affiliate commission level
"""
currentDeveloperCommissionPercent: Int!
"""
Your current referral commission level
"""
currentReferralCommissionPercent: Int!
"""
Sum of developer and referral commission paid over last 30 days
"""
last30DaysCommissionUsd: CurrencyAmount
"""
Commission paid in last 30 days on qualifying developer volume
"""
last30DaysDeveloperCommissionUsd: CurrencyAmount
"""
Qualifying volume generated by attaching developer code to orders
"""
last30DaysDeveloperQualifyingVolumeUsd: CurrencyAmount
"""
Sum of developer and referral qualifying volume over last 30 days
"""
last30DaysQualifyingVolumeUsd: CurrencyAmount
"""
Commission paid in last 30 days on qualifying referral volume
"""
last30DaysReferralCommissionUsd: CurrencyAmount
"""
Qualifying volume generated by referred users in last 30 days
"""
last30DaysReferralQualifyingVolumeUsd: CurrencyAmount
"""
list of daily affiliate payouts
"""
statements: [AffiliateStatement]!
"""
Year this page of statements convers
"""
year: Int!
}
type ApiLimit {
maxCallsPerTimePeriod: Int
requestName: String
timePeriod: String
}
type Asset {
blockchain: String!
blockchainPrecision: Int!
depositPrecision: Int!
fiatPrice(fiatSymbol: String): Float
hash: Base16!
name: String!
symbol: CurrencySymbol!
withdrawalPrecision: Int!
}
type AssetNonces {
asset: CurrencySymbol!
nonces: [Int!]!
}
type BankDepositInstructions {
bic: String!
iban: String!
recipientName: String!
referenceCode: String!
}
type BankDepositReceived {
amount: CurrencyAmount!
receivedAt: Date!
senderIban: String
}
"""
Binary data represented in base 16, it should be lowercase and not have 0x prefix
"""
scalar Base16
enum Blockchain {
BTC
ETH
NEO
}
enum BlockchainName {
"""
bitcoin.
"""
BTC
"""
ethereum
"""
ETH
"""
neo
"""
NEO
}
input BlockchainSignature {
blockchain: Blockchain!
nonceFrom: Int
nonceTo: Int
publicKey: Base16
"""
The r part of the MPC signature only required when using MPC signatures, should be a base16 string
"""
r: Base16
signature: Base16!
}
input CancelAllOrdersParams {
"""
If provided only cancel orders in given market. Otherwise cancel all.
"""
marketName: MarketName
"""
When the request was generated - integer timestamp in milliseconds
"""
timestamp: Int!
}
type CanceledOrder {
orderId: ID
}
type CanceledOrders {
accepted: Boolean
}
input CancelOrderParams {
marketName: MarketName!
orderId: ID!
"""
When the request was generated - integer timestamp in milliseconds
"""
timestamp: Int!
}
type Candle {
aVolume: CurrencyAmount
bVolume: CurrencyAmount
closePrice: CurrencyPrice
highPrice: CurrencyPrice
interval: CandleInterval
intervalStartingAt: DateTime
lowPrice: CurrencyPrice
openPrice: CurrencyPrice
}
enum CandleInterval {
FIFTEEN_MINUTE
FIVE_MINUTE
FOUR_HOUR
ONE_DAY
ONE_HOUR
ONE_MINUTE
ONE_MONTH
ONE_WEEK
SIX_HOUR
THIRTY_MINUTE
THREE_HOUR
TWELVE_HOUR
}
type CandleRange {
candles: [Candle!]!
market: Market
"""
Value to use for next `before` pagination cursor
"""
next: DateTime
}
input ClientSignedMessage {
blockchain: Blockchain
message: Base16
r: Base16
signature: Base16
}
type CompanyResponse {
address: String
contactNumber: String
id: ID!
name: String
owner: AccountResponse
website: String
}
type CompletePayloadSignatureResponse {
signature: Base16
}
enum CompletePayloadSignatureType {
BLOCKCHAIN
MOVEMENT
}
type Confirmations {
denominator: Int
numerator: Int
}
type Contact {
country: String
countryCode: String
email: String
firstName: String
id: ID!
"""
max 500kb
"""
image: String
invitationSent: Boolean!
lastName: String
phone: String
wallets: [ContactWallet!]!
}
"""
Contact input
"""
input ContactInput {
country: String
countryCode: String
email: String
firstName: String
lastName: String
phone: String
}
input ContactSearchFilters {
blockchain: BlockchainName
email: String
firstName: String
id: String
lastName: String
phone: String
textSearch: String
withWallets: Boolean
}
type ContactWallet {
address: String!
blockchain: BlockchainName!
id: ID!
label: String
}
"""
Contact Wallet input
"""
input ContactWalletInput {
address: String
blockchain: BlockchainName
contactId: ID
label: String
}
type CorrectKeyProof {
sigmaVec: [Base16]!
}
enum CountryStatusEnum {
"""
Allowed country
"""
ALLOWED
"""
Blocked country
"""
BLOCKED
"""
Restricted country
"""
RESTRICTED
}
input CreatePayoutPaymentMethodInput {
accountHolderName: String!
currency: CurrencySymbol!
description: String!
iban: String!
isDefault: Boolean
}
type CreateTokenResponse {
token: String!
}
type CreateTwoFactorResponse {
twoFactorCode: String!
uriString: String!
}
"""
A graphql representation of an amount of crypto or fiat currency.
"""
type CurrencyAmount {
amount: CurrencyNumber!
currency: CurrencySymbol!
}
"""
A graphql representation of an amount of crypto or fiat currency for input.
"""
input CurrencyAmountParams {
amount: CurrencyNumber!
currency: CurrencySymbol!
}
"""
The number portion of a currency as a String - must contain only numbers and a single period
"""
scalar CurrencyNumber
"""
A graphql representation of a price rate for crypto or fiat currency.
"""
type CurrencyPrice {
amount: CurrencyNumber!
currencyA: CurrencySymbol!
currencyB: CurrencySymbol!
}
"""
A graphql representation of a price rate for crypto or fiat currency input.
"""
input CurrencyPriceParams {
amount: CurrencyNumber!
currencyA: CurrencySymbol!
currencyB: CurrencySymbol!
}
"""
Unit of a currency as a String
"""
scalar CurrencySymbol
"""
The `Date` scalar type represents a date. The Date appears in a JSON
response as an ISO8601 formatted string, without a time component.
"""
scalar Date
"""
The `DateTime` scalar type represents a date and time in the UTC
timezone. The DateTime appears in a JSON response as an ISO8601 formatted
string, including UTC timezone ("Z"). The parsed date and time string will
be converted to UTC if there is an offset.
"""
scalar DateTime
type Device {
activity: Activity!
id: ID!
verified: Boolean!
}
enum Direction {
BUY
SELL
}
type DisabledFeature {
feature: Feature!
reasonSlugs: [ReasonForFeatureDisabled!]!
}
type DiscourseAccountStatusResponse {
externalEmail: String
externalId: String
new: Boolean!
username: String
}
type DiscourseLoginResponse {
url: String!
}
type EmailNotificationSettings {
fundsTradingToPersonal: Boolean!
stakingStakeComplete: Boolean!
}
input EmailNotificationSettingsInput {
fundsTradingToPersonal: Boolean
stakingStakeComplete: Boolean
}
"""
Aggregated exchange metrics over a period
"""
type ExchangeAssetMetric {
asset: Asset
assetSymbol: CurrencySymbol!