forked from gobitfly/eth2-knowledge-base
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.json
More file actions
8406 lines (8351 loc) · 278 KB
/
Copy pathapi.json
File metadata and controls
8406 lines (8351 loc) · 278 KB
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
openapi: 3.0.0
info:
title: beaconcha.in Multi EVM API
description: |-
Supported networks: Ethereum (CL+EL), Gnosis (EL), Optimism. Some comments are in https://docs.google.com/document/d/1c0JXxsMj9qa_RfEG4ecodVlJZPYUayI8UBY8HyBFR7Q/edit?usp=sharing'
To authenticate your API request beaconcha.in uses API Keys. Supply your API Key either by:
- Setting the `Authorization` header in the following format: `Authorization: Bearer <your-api-key>`. (recommended)
- Setting the URL query parameter in the following format: `api_key={your_api_key}`.\
Example: `https://beaconcha.in/api/v2/example?field=value&api_key={your_api_key}`
version: 2.4.0.lucca
contact: {}
servers:
- url: https://beaconcha.in
paths:
/api/v2/healthz:
get:
description: Health endpoint for monitoring whether the explorer is synchronized.
tags:
- Health
summary: Health of the explorer
responses:
'200':
description: OK
content:
text/plain:
schema:
allOf:
- $ref: '#/components/schemas/APIHealthResponse'
/api/v2/healthz-loadbalancer:
get:
description: Health endpoint for monitoring whether the explorer-api maintains a healthy connection to the database.
tags:
- Health
summary: Health of the explorer-api
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
/api/i/login:
post:
tags:
- Authentication
description: |-
**Internal only!!** Create a new login session.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
responses:
'200':
description: OK. Session cookie is set.
headers:
location:
schema:
type: string
description: Redirect location.
'400':
description: Bad Request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/i/oauth/authorize:
post:
tags:
- Authentication
description: |-
**Internal only!!** Create an authorization request using the Authorization Code Flow with PKCE. **Note:** This endpoint is the internal request sent after the `GET /authorize` (see [RFC 7636 Section 4.3](https://datatracker.ietf.org/doc/html/rfc7636#section-4.3)) request is approved by the user. This specific endpoint underlies no RFC specification. If the user approves, the response will automatically redirect the user.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
response_type:
type: string
client_id:
type: string
redirect_uri:
type: string
scope:
type: string
state:
type: string
code_challenge:
type: string
code_challenge_method:
type: string
responses:
'302':
description: Found
headers:
location:
schema:
type: string
description: Redirect location.
'400':
description: Bad Request. The request could not be processed because the `redirect_uri` parameter was invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/oauth/token:
post:
tags:
- Authentication
description: |-
Get an access token using either the [Authorization Code Flow with PKCE](https://datatracker.ietf.org/doc/html/rfc7636#section-4.5) or a [Refresh Token](https://datatracker.ietf.org/doc/html/rfc6749#section-6).
requestBody:
required: true
description: Please note that the media type must be `application/x-www-form-urlencoded`, **not** JSON.
content:
application/x-www-form-urlencoded:
schema:
oneOf:
- type: object
properties:
grant_type:
type: string
client_id:
type: string
code:
type: string
code_verifier:
type: string
redirect_uri:
type: string
- type: object
properties:
grant_type:
type: string
refresh_token:
type: string
scope:
type: string
examples:
Authorization Code Flow with PKCE:
value:
grant_type: authorization_code
client_id: string
code: string
code_verifier: string
redirect_url: string
Refresh Token:
value:
grant_type: refresh_token
refresh_token: string
scope: string
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
access_token:
type: string
refresh_token:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/i/oauth/token:
post:
tags:
- Authentication
description: |-
**For web frontend login only!** Exchange user credentials for a token using the Resource Owner Password Flow. See [RFC 6749 Section 4.3.2](https://datatracker.ietf.org/doc/html/rfc6749#section-4.3.2) for a detailed description of the specifications.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
grant_type:
type: string
username:
type: string
password:
type: string
scope:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
access_token:
type: string
refresh_token:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/i/users/me/api-keys:
post:
tags:
- Authentication
description: |-
Create a new API key, used for public API endpoints.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
scope:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
api_key:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/i/ad-configurations:
post:
tags:
- Ad Configurations
description: Create a new ad configuration.
requestBody:
required: true
description: |-
`key`: Provide a key for the ad configuration. Does not need to be unique.
`jquery_selector`: Provide a jQuery selector for the ad configuration.
`insert_mode`: Provide the insert mode for the ad configuration. Possible values are `before`, `after`, `replace`, `insert`.
`refresh_interval`: Provide the refresh interval for the ad configuration in seconds.
`for_all_users`: Provide whether the ad configuration is for all users, even if they have NoAds enabled.
`banner_id`: Provide the banner id for the ad configuration. Mutually exclusive with `html_content`.
`html_content`: Provide the html content for the ad configuration. Mutually exclusive with `banner_id`.
`enabled`: Provide whether the ad configuration is enabled.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AdConfigurationResponse'
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
$ref: '#/components/schemas/AdConfigurationResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
get:
tags:
- Ad Configurations
description: Get a list of ad configurations.
parameters:
- name: keys
in: query
description: Provide a comma seperated list of keys to filter the ad configurations by. If ommited, all ad configurations will be returned.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/AdConfigurationResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/i/ad-configurations/{key}:
put:
tags:
- Ad Configurations
description: Update an existing ad configuration.
parameters:
- name: key
in: path
description: Provide the key of the ad configuration to update.
required: true
schema:
type: string
requestBody:
required: true
description: |-
`jquery_selector`: Provide a jQuery selector for the ad configuration.
`insert_mode`: Provide the insert mode for the ad configuration. Possible values are `before`, `after`, `replace`, `insert`.
`refresh_interval`: Provide the refresh interval for the ad configuration in seconds.
`for_all_users`: Provide whether the ad configuration is for all users, even if they have NoAds enabled.
`banner_id`: Provide the banner id for the ad configuration. Mutually exclusive with `html_content`.
`html_content`: Provide the html content for the ad configuration. Mutually exclusive with `banner_id`.
`enabled`: Provide whether the ad configuration is enabled.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AdConfigurationResponse'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
$ref: '#/components/schemas/AdConfigurationResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
delete:
tags:
- Ad Configurations
description: Delete an ad configuration.
parameters:
- name: key
in: path
description: Provide the key of the ad configuration to update.
required: true
schema:
type: string
responses:
'204':
description: No Content. The request was successful.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/users/me/dashboards:
get:
tags:
- Dashboards
description: Get a list of dashboards associated with the authenticated user.
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
validator_dashboards:
type: array
items:
$ref: '#/components/schemas/Dashboard'
account_dashboards:
type: array
items:
$ref: '#/components/schemas/Dashboard'
/api/i/search:
post:
tags:
- Search
description: |-
Search endpoint. Request body fields:
- `input` - Provide the search query.
- `networks` (optional) - Provide an array of network names or chain IDs to filter results by.
- `types` (optional) - Provide an array of types to filter results by. Possible options:
- `validator_by_index`
- `validator_by_public_key`
- `validators_by_deposit_address`
- `validators_by_deposit_ens_name`
- `validators_by_withdrawal_credential`
- `validators_by_withdrawal_address`
- `validators_by_withdrawal_ens`
- `validators_by_graffiti`
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
input:
type: string
networks:
type: array
items:
type: integer
format: int64
types:
type: array
items:
type: string
include_validators:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
type:
type: string
chain_id:
type: integer
format: int64
hash_value:
type: string
nullable: true
str_value:
type: string
nullable: true
num_value:
type: integer
format: int64
nullable: true
validators:
type: array
items:
type: integer
format: int64
nullable: true
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards:
post:
tags:
- Account Dashboards
description: Create a new account dashboard. **Note:** New dashboards will automatically have a default group created.
requestBody:
required: true
description: |-
`name`: Specify the name of the dashboard.
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
id:
type: string
name:
type: string
'400':
description: Bad Request. The request could not be performed by the server due to invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
'409':
description: Conflict. The request could not be performed by the server because the authenticated user has already reached their dashboard limit.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}:
get:
tags:
- Account Dashboards
description: Get overview information for a specified dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
groups:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
accounts:
type: array
items:
type: object
properties:
address:
type: string
group_id:
type: number
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
delete:
tags:
- Account Dashboards
description: Delete a specified account dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
responses:
'204':
description: No Content. The request was successful.
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/groups:
post:
tags:
- Account Dashboards
description: Create a new group in a specified account dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
required: true
description: |-
`name`: Specify the name of the group.
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
id:
type: string
name:
type: string
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
'409':
description: Conflict. The request could not be performed by the server because the authenticated user has already reached their dashboard group limit.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/groups/{group_id}:
put:
tags:
- Account Dashboards
description: Update a group's name in a specified account dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/GroupIdPath'
requestBody:
required: true
description: |-
`name`: Specify the name of the group.
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
id:
type: string
name:
type: string
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
delete:
tags:
- Account Dashboards
description: Delete a specified group in a specified dashboard. All included accounts will be moved to the default group.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/GroupIdPath'
responses:
'204':
description: No Content. The request was successful.
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/accounts:
post:
tags:
- Account Dashboards
description: Add new accounts to a specified dashboard or update the group of already-added accounts.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
description: |-
`accounts`: Provide an array of account addresses that should get added.
`group_id`: (optional) Provide a single group id, to which all accounts get added to. If ommited, the default group will be used.
required: true
content:
application/json:
schema:
type: object
properties:
accounts:
type: array
items:
type: string
group_id:
type: number
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: array
items:
type: object
properties:
public_key:
type: string
group_id:
type: number
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
'409':
description: Conflict. The request could not be performed by the server because the authenticated user has already reached their dashboard accounts limit.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
get:
tags:
- Account Dashboards
description: Get a list of accounts for a specified dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/NetworkParameter'
- $ref: '#/components/parameters/CursorParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/SortParameter'
- $ref: '#/components/parameters/SearchParameter'
responses:
'200':
description: OK. TODO Response Object
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
delete:
tags:
- Account Dashboards
description: Remove specific accounts from a dashboard
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- name: accounts
in: query
description: |-
Provide a comma seperated list of accounts that should get removed. If ommited, all accounts will be removed from the dashboard.
**Internal Note:** should have request body for extensive requests like `PUT /api/i/notification-dashboards/{dashboard_id}/validators/events`, but OpenAPI 3.0 standard forbids request body for `DELETE` endpoints.
schema:
type: string
responses:
'204':
description: No Content. The request was successful.
'400':
description: Bad Request. Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/accounts/{address}:
put:
tags:
- Account Dashboards
description: |-
Set the color associated with a specific account, which will be visible on the transactions table on the frontend.
**Internal note:** Maybe we won't document this publicly.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/AddressParameter'
requestBody:
description: '`color`: Provide the hex color in the format `#FFFFFF`.'
required: true
content:
application/json:
schema:
type: object
properties:
color:
type: string
visible:
type: boolean
responses:
'200':
description: OK
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/public-ids:
post:
tags:
- Account Dashboards
description: Create a new public ID for a specified dashboard. This token can be used as an ID by other users for non-modyfing (i.e. GET) endpoints only. Currently limited to one per dashboard.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
requestBody:
required: true
description: |-
`name`: Provide a public name for the dashboard
`share_settings`:
- `group_names`: If set to `true`, group names are shown publicly.
- `transactions_table_settings`: if set to `true`, the settings for the transactions table are used publicly.
content:
application/json:
schema:
type: object
properties:
name:
type: string
share_settings:
type: object
properties:
group_names:
type: boolean
transactions_table_settings:
type: boolean
responses:
'201':
description: Created
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
access_token:
type: string
name:
type: string
share_settings:
type: object
properties:
group_names:
type: boolean
transactions_table_settings:
type: boolean
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
'409':
description: Conflict. The request could not be performed by the server because the authenticated user has already reached their public ID limit for this dashboard.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/public-ids/{public_dashboard_id}:
put:
tags:
- Account Dashboards
description: Update a specified public ID for a specified dashboard.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/DashboardTokenPath'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
share_settings:
type: object
properties:
group_names:
type: boolean
transactions_table_settings:
type: boolean
responses:
'200':
description: OK.
content:
application/json:
schema:
allOf:
- type: object
properties:
data:
type: object
properties:
access_token:
type: string
share_settings:
type: object
properties:
group_names:
type: boolean
transactions_table_settings:
type: boolean
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
delete:
tags:
- Account Dashboards
description: Delete a public public ID for a specified dashboard.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/DashboardTokenPath'
responses:
'204':
description: No Content. The request was successful.
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessageResponse'
/api/v2/account-dashboards/{dashboard_id}/transactions:
get:
tags:
- Account Dashboards
description: Get a list of the latest transactions associated with a dashboards accounts.
parameters:
- $ref: '#/components/parameters/DashboardIdPath'
- $ref: '#/components/parameters/DashboardGroupParameter'
- $ref: '#/components/parameters/HideSpamParameter'
- $ref: '#/components/parameters/NetworkParameter'
- $ref: '#/components/parameters/TokenParameter'
- $ref: '#/components/parameters/MethodParameter'
- $ref: '#/components/parameters/TransactionDirectionParameter'
- $ref: '#/components/parameters/TransactionTypeParameter'
- $ref: '#/components/parameters/StartDateParameter'
- $ref: '#/components/parameters/EndDateParameter'
- $ref: '#/components/parameters/StartBlockParameter'
- $ref: '#/components/parameters/EndBlockParameter'
- $ref: '#/components/parameters/CursorParameter'
- $ref: '#/components/parameters/LimitParameter'
- $ref: '#/components/parameters/SortParameter'
- $ref: '#/components/parameters/SearchParameter'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PagingResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/EthereumTransactionResponse'
'400':
description: Bad Request. The request could not be performed by the server due to malformed syntax or invalid parameters.