forked from farcasterxyz/hub-monorepo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.yaml
1967 lines (1967 loc) · 59.2 KB
/
spec.yaml
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.1
info:
title: Farcaster Hub REST API
version: "1.0"
description: >
Perform basic queries of Farcaster state via the REST API of a Farcaster hub.
See the [Farcaster docs](https://www.thehubble.xyz/docs/httpapi/httpapi.html) for more details.
Some client libraries:
- [TypeScript](https://www.npmjs.com/package/@standard-crypto/farcaster-js-hub-rest)
servers:
- url: https://nemes.farcaster.xyz:2281
- url: https://hub.farcaster.standardcrypto.vc:2281
security: []
paths:
/v1/info:
get:
tags:
- Info
summary: Sync Methods
operationId: GetInfo
parameters:
- name: dbstats
in: query
description: Whether to return DB stats
required: true
schema:
type: boolean
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/HubInfoResponse'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/castById:
get:
tags:
- Casts
summary: Get a cast by its FID and Hash.
operationId: GetCastById
parameters:
- name: fid
in: query
description: The FID of the cast's creator
required: true
schema:
type: integer
example: 6833
- name: hash
in: query
description: The cast's hash
required: true
schema:
pattern: ^0x[0-9a-fA-F]{40}$
type: string
example: '0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9'
responses:
200:
description: The requested Cast.
content:
application/json:
schema:
$ref: '#/components/schemas/CastAdd'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/castsByFid:
get:
tags:
- Casts
summary: Fetch all casts authored by an FID.
operationId: ListCastsByFid
parameters:
- name: fid
in: query
description: The FID of the casts' creator
required: true
schema:
type: integer
example: 6833
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Casts.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/CastAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/castsByMention:
get:
tags:
- Casts
summary: Fetch all casts that mention an FID
operationId: ListCastsByMention
parameters:
- name: fid
in: query
description: The FID that is mentioned in a cast
required: true
schema:
type: integer
example: 6833
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Casts.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/CastAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/castsByParent:
get:
tags:
- Casts
summary: Fetch all casts by parent cast's FID and Hash OR by the parent's URL
operationId: ListCastsByParent
parameters:
- name: fid
in: query
description: The FID of the parent cast
schema:
type: integer
example: 226
- name: hash
in: query
description: The parent cast's hash
schema:
type: string
example: '0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9'
- name: url
in: query
schema:
type: string
example: chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Casts.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/CastAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/reactionById:
get:
tags:
- Reactions
summary: Get a reaction by its created FID and target Cast.
operationId: GetReactionById
parameters:
- name: fid
in: query
description: The FID of the reaction's creator
schema:
type: integer
required: true
- name: target_fid
in: query
description: The FID of the cast's creator
schema:
type: integer
required: true
- name: target_hash
in: query
description: The cast's hash
schema:
type: string
required: true
- name: reaction_type
in: query
description: The type of reaction, either as a numerical enum value or string representation
schema:
$ref: '#/components/schemas/ReactionType'
required: true
responses:
200:
description: The requested Reaction.
content:
application/json:
schema:
$ref: '#/components/schemas/Reaction'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/reactionsByCast:
get:
tags:
- Reactions
summary: Get all reactions to a cast
operationId: ListReactionsByCast
parameters:
- name: target_fid
in: query
description: The FID of the cast's creator
schema:
type: integer
required: true
- name: target_hash
in: query
description: The hash of the cast
schema:
type: string
required: true
- name: reaction_type
in: query
description: The type of reaction, either as a numerical enum value or string representation
schema:
$ref: '#/components/schemas/ReactionType'
required: true
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Reactions.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Reaction'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/reactionsByFid:
get:
tags:
- Reactions
summary: Get all reactions by an FID
operationId: ListReactionsByFid
parameters:
- name: fid
in: query
description: The FID of the reaction's creator
schema:
type: integer
required: true
- name: reaction_type
in: query
description: The type of reaction, either as a numerical enum value or string representation
schema:
$ref: '#/components/schemas/ReactionType'
required: true
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Reactions.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Reaction'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/reactionsByTarget:
get:
tags:
- Reactions
operationId: ListReactionsByTarget
summary: Get all reactions to a target URL
parameters:
- name: url
in: query
description: The URL of the parent cast
schema:
type: string
required: true
example: chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2
- name: reaction_type
in: query
description: The type of reaction, either as a numerical enum value or string representation
schema:
$ref: '#/components/schemas/ReactionType'
required: true
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Reactions.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Reaction'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/linkById:
get:
tags:
- Links
summary: Get a link by its FID and target FID.
operationId: GetLinkById
parameters:
- name: fid
in: query
description: The FID of the link's originator
required: true
schema:
type: integer
- name: target_fid
in: query
description: The FID of the target of the link
required: true
schema:
type: integer
- name: link_type
in: query
description: The type of link, as a string value
required: true
schema:
$ref: '#/components/schemas/LinkType'
responses:
200:
description: The requested Link.
content:
application/json:
schema:
$ref: '#/components/schemas/LinkAdd'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/linksByFid:
get:
tags:
- Links
summary: Get all links from a source FID
operationId: ListLinksByFid
parameters:
- name: fid
in: query
schema:
type: integer
required: true
description: The FID of the link's originator
- name: link_type
in: query
schema:
$ref: '#/components/schemas/LinkType'
required: false
description: The type of link, as a string value
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Links.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/LinkAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/linksByTargetFid:
get:
tags:
- Links
summary: Get all links to a target FID
operationId: ListLinksByTargetFid
parameters:
- name: target_fid
in: query
schema:
type: integer
required: true
description: The FID of the target of the link
- name: link_type
in: query
schema:
$ref: '#/components/schemas/LinkType'
required: false
description: The type of link, as a string value
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Links.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/LinkAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/userDataByFid:
get:
tags:
- UserData
summary: Get UserData for a FID.
description: "**Note:** one of two different response schemas is returned
based on whether the caller provides the `user_data_type` parameter. If included, a single
`UserDataAdd` message is returned (or a `not_found` error). If omitted, a paginated list
of `UserDataAdd` messages is returned instead"
operationId: GetUserDataByFid
parameters:
- name: fid
in: query
description: The FID that's being requested
schema:
type: integer
required: true
- name: user_data_type
in: query
description: The type of user data, either as a numerical value or type string. If this is omitted, all user data for the FID is returned
schema:
$ref: '#/components/schemas/UserDataType'
required: false
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested UserData.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/UserDataAdd'
- type: object
required:
- messages
- nextPageToken
properties:
messages:
type: array
items:
$ref: '#/components/schemas/UserDataAdd'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
/v1/fids:
get:
tags:
- FIDs
operationId: ListFids
summary: Get a list of all the FIDs
parameters:
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/FidsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/storageLimitsByFid:
get:
tags:
- Storage
operationId: GetStorageLimitsByFid
summary: Get an FID's storage limits.
parameters:
- name: fid
in: query
required: true
schema:
type: integer
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLimitsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
x-codegen-request-body-name: body
/v1/userNameProofsByFid:
get:
tags:
- Usernames
operationId: ListUsernameProofsByFid
summary: Get a list of proofs provided by an FID
parameters:
- name: fid
in: query
schema:
type: integer
required: true
description: The FID being requested
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/UsernameProofsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/userNameProofByName:
get:
tags:
- Usernames
summary: Get an proof for a username by the Farcaster username
operationId: GetUsernameProof
parameters:
- name: name
in: query
schema:
type: string
required: true
description: The Farcaster username or ENS address
examples:
username:
value: "gavi"
"ENS address":
value: "dwr.eth"
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/UserNameProof'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/verificationsByFid:
get:
tags:
- Verifications
operationId: ListVerificationsByFid
summary: Get a list of verifications provided by an FID
parameters:
- name: fid
in: query
required: true
schema:
type: integer
description: The FID being requested
- name: address
in: query
required: false
schema:
type: string
description: The optional ETH address to filter by
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/paginationReverse'
- $ref: '#/components/parameters/pageToken'
responses:
200:
description: The requested Reactions.
content:
application/json:
schema:
required:
- messages
- nextPageToken
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Verification'
nextPageToken:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
default:
$ref: '#/components/responses/ErrorResponse'
x-codegen-request-body-name: body
/v1/onChainIdRegistryEventByAddress:
get:
tags:
- OnChainEvents
summary: Get an on chain ID Registry Event for a given Address
operationId: GetOnChainIdRegistrationByAddress
parameters:
- name: address
in: query
required: true
schema:
type: string
pattern: ^0x[0-9a-fA-F]{40}$
description: The ETH address being requested
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/OnChainEventIdRegister'
default:
$ref: '#/components/responses/ErrorResponse'
/v1/onChainEventsByFid:
get:
tags:
- OnChainEvents
summary: Get a list of on-chain events provided by an FID
operationId: ListOnChainEventsByFid
parameters:
- name: fid
in: query
required: true
schema:
type: integer
description: The FID being requested
- name: event_type
in: query
schema:
$ref: '#/components/schemas/OnChainEventType'
description: The numeric of string value of the event type being requested.
required: true
responses:
200:
description: A successful response.
content:
application/json:
schema:
type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/OnChainEvent'
required:
- events
default:
$ref: '#/components/responses/ErrorResponse'
/v1/onChainSignersByFid:
get:
tags:
- OnChainEvents
summary: Get a list of signers provided by an FID
description: "**Note:** one of two different response schemas is returned
based on whether the caller provides the `signer` parameter. If included, a single
`OnChainEventSigner` message is returned (or a `not_found` error). If omitted, a
non-paginated list of `OnChainEventSigner` messages is returned instead"
operationId: ListOnChainSignersByFid
parameters:
- name: fid
in: query
required: true
schema:
type: integer
description: The FID being requested
- name: signer
in: query
schema:
type: string
description: The optional key of signer
required: false
example: "0x0852c07b5695ff94138b025e3f9b4788e06133f04e254f0ea0eb85a06e999cdd"
responses:
200:
description: A successful response.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/OnChainEventSigner'
- type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/OnChainEventSigner'
required:
- events
default:
$ref: '#/components/responses/ErrorResponse'
/v1/submitMessage:
post:
tags:
- SubmitMessage
summary: Submit a signed protobuf-serialized message to the Hub
operationId: SubmitMessage
security:
- usernamePassword: []
requestBody:
description: "* \nA Message is a delta operation on the Farcaster network.\
\ The message protobuf is an envelope \nthat wraps a MessageData object\
\ and contains a hash and signature which can verify its authenticity."
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
$ref: '#/components/responses/ErrorResponse'
x-codegen-request-body-name: body
/v1/validateMessage:
post:
tags:
- ValidateMessage
summary: Validate a signed protobuf-serialized message with the Hub
operationId: ValidateMessage
security:
- usernamePassword: []
requestBody:
description: "* \nA Message is a delta operation on the Farcaster network.\
\ The message protobuf is an envelope \nthat wraps a MessageData object\
\ and contains a hash and signature which can verify its authenticity."
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateMessageResponse'
default:
$ref: '#/components/responses/ErrorResponse'
x-codegen-request-body-name: body
/v1/events:
get:
tags:
- HubEvents
operationId: ListEvents
summary: Get a page of Hub events
parameters:
- name: from_event_id
in: query
required: false
schema:
type: integer
description: "An optional Hub Id to start getting events from.
This is also returned from the API as nextPageEventId, which
can be used to page through all the Hub events. Set it to 0
to start from the first event"
responses:
200:
description: A successful response.
content:
application/json:
schema:
type: object
properties:
nextPageEventId:
type: integer
events:
type: array
items:
$ref: '#/components/schemas/HubEvent'
required:
- nextPageEventId
- events
default:
$ref: '#/components/responses/ErrorResponse'
/v1/eventById:
get:
tags:
- HubEvents
operationId: GetEventById
summary: Get an event by its ID
parameters:
- name: event_id
in: query
required: true
schema:
type: integer
description: The Hub Id of the event
responses:
200:
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/HubEvent'
default:
$ref: '#/components/responses/ErrorResponse'
components:
securitySchemes:
usernamePassword:
type: http
scheme: basic
parameters:
pageSize:
name: pageSize
in: query
description: Maximum number of messages to return in a single response
schema:
type: integer
paginationReverse:
name: reverse
in: query
description: Reverse the sort order, returning latest messages first
schema:
type: boolean
pageToken:
name: pageToken
in: query
description: The page token returned by the previous query, to fetch the next
page. If this parameter is empty, fetch the first page
schema:
type: string
schemas:
CastAdd:
allOf:
- $ref: '#/components/schemas/MessageCommon'
- type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/MessageDataCastAdd'
- type: object
properties:
type:
$ref: '#/components/schemas/MessageType'
required:
- type
required:
- data
CastAddBody:
description: 'Adds a new Cast'
type: object
properties:
embedsDeprecated:
title: URLs to be embedded in the cast
type: array
items:
type: string
mentions:
title: Fids mentioned in the cast
type: array
items:
type: integer
format: uint64
example: 2
parentCastId:
$ref: '#/components/schemas/CastId'
parentUrl:
title: Parent URL
type: string
example: chain://eip155:1/erc721:0x39d89b649ffa044383333d297e325d42d31329b2
text:
title: Text of the cast
type: string
mentionsPositions:
title: Positions of the mentions in the text
type: array
items:
type: integer
format: int64
embeds:
title: URLs or cast ids to be embedded in the cast
type: array
items:
$ref: '#/components/schemas/Embed'
required:
- embedsDeprecated
- mentions
- text
- mentionsPositions
- embeds
CastEmbed:
type: object
properties:
castId:
$ref: '#/components/schemas/CastId'
required:
- castId
CastRemove:
allOf:
- $ref: '#/components/schemas/MessageCommon'
- type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/MessageDataCastRemove'
- type: object
properties:
type:
$ref: '#/components/schemas/MessageType'
required:
- type
required:
- data
CastId:
description: 'Identifier used to look up a Cast'
required:
- fid
- hash
type: object
properties:
fid:
title: Fid of the user who created the cast
type: integer