-
Notifications
You must be signed in to change notification settings - Fork 29
/
pinata-api-v3-farcaster.yaml
1841 lines (1839 loc) · 67.5 KB
/
pinata-api-v3-farcaster.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.0
info:
version: 1.0.0
title: Pinata Farcaster API
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
paths:
'/casts/{hash}':
get:
tags:
- default
summary: Cast by Hash
parameters:
- name: hash
in: path
description: The full hash of the cast you want to fetch
required: true
schema:
type: string
example: '0x48895560a708870f4833207152dc2ab9427f8a55'
examples:
default:
value: '0x48895560a708870f4833207152dc2ab9427f8a55'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
cast:
author:
active_status: inactive
custody_address: '0x456131161f83c7d7fda15b32a5f7c21fd4e27e96'
display_name: Steve
fid: 6023
follower_count: 5095
following_count: 936
object: user
pfp_url: >-
https://p765cpbvm0.execute-api.eu-central-1.amazonaws.com/p1/renderer/Minteeble/chain/base/collection/6e0b39a5-8569-4e67-b330-d352593c9629/image/176.png
power_badge: true
profile:
bio:
mentioned_profiles: []
text: >-
Head of Developer Relations at /pinata | Technical
Writer | Building honeythread.xyz | Tinkering
Photocaster | stevedylan.dev/links
username: stevedylandev.eth
verifications:
- '0xad73eafcac4f4c6755dfc61770875fb8b6bc8a25'
verified_addresses:
eth_addresses:
- '0xad73eafcac4f4c6755dfc61770875fb8b6bc8a25'
sol_addresses: []
embeds:
- cast_id:
fid: 6023
hash: '0x4579466d6555e3d42a9fc579c3763342f85292fb'
- url: http://dietcast.xyz
frames:
- buttons:
- action_type: link
index: 1
target: https://dietcast.xyz
title: Visit
- action_type: link
index: 2
target: >-
https://www.pinata.cloud/blog/how-to-build-a-lite-client-with-the-pinata-farcaster-api
title: Tutorial
- action_type: link
index: 3
target: https://github.com/PinataCloud/diet-cast
title: Repo
frames_url: http://dietcast.xyz
image: >-
https://dweb.mypinata.cloud/ipfs/QmYZArEWBaAosWP1XRAB1zLK1kK7zScia4rHbv62xKs3zo?filename=og.png
input: {}
state: {}
title: Diet Cast
version: vNext
hash: '0x48895560a708870f4833207152dc2ab9427f8a55'
mentioned_profiles: []
object: cast
parent_author:
fid: null
parent_hash: null
parent_url: https://warpcast.com/~/channel/fc-devs
reactions:
likes:
- fid: 646
fname: 0xshash
- fid: 394037
fname: kis201
- fid: 249109
fname: scottcooper
- fid: 3621
fname: portlymerchant.eth
- fid: 2902
fname: falcon
likes_count: 9
recasts:
- fid: 3621
fname: portlymerchant.eth
recasts_count: 1
replies:
count: 1
root_parent_url: https://warpcast.com/~/channel/fc-devs
text: >-
New lite client is live! Check out how we made it with the
tutorial and open source repo linked in the frame 🥤
dietcast.xyz
thread_hash: '0x48895560a708870f4833207152dc2ab9427f8a55'
timestamp: '2024-04-30T15:16:27.000Z'
headers:
Date:
schema:
type: string
example: 'Thu, 07 Mar 2024 14:45:57 GMT'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Content-Length:
schema:
type: integer
example: 1190
Connection:
schema:
type: string
example: keep-alive
X-Request-Id:
schema:
type: string
example: 71fd2728094f11bd4fce115cc2e5c34c
Strict-Transport-Security:
schema:
type: string
example: max-age=15724800; includeSubDomains
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
delete:
tags:
- default
summary: Delete Cast
parameters:
- name: signerId
in: query
description: Signer ID for the author of the cast
required: true
schema:
type: string
example: e5cf5d84-7671-4402-8df0-84b0efdc24cd
examples:
default:
value: e5cf5d84-7671-4402-8df0-84b0efdc24cd
- name: hash
in: path
description: Hash for the cast to be deleted
required: true
schema:
type: string
example: '0xf4da10b7e1390d7b487ee6d343f51e9061212563'
examples:
default:
value: '0xf4da10b7e1390d7b487ee6d343f51e9061212563'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
data:
data:
type: MESSAGE_TYPE_CAST_REMOVE
fid: 401191
timestamp: 102563506
network: FARCASTER_NETWORK_MAINNET
castAddBody:
embedsDeprecated: null
mentions: null
hash: '0x1ccade8ff46e21ddca30fdcbe0630265e2da9c7e'
hashScheme: HASH_SCHEME_BLAKE3
signature: 9byndiIE1CL62dYMhcsEQLxIKa1m4r+3Q3XZJpxFBwxn/CL+qHohD7ugFl3yru5ng3p08RJRbo+xzYYFtQqaDw==
signatureScheme: SIGNATURE_SCHEME_ED25519
signer: '0x86367a36c3c181c46acdc6027109dbaa75c5fbc97c500af23f1ea8c987f12375'
dataBytes: CAIQp74YGLL98zAgATIWChT02hC34TkNe0h+5tND9R6QYSElYw==
headers:
Access-Control-Allow-Headers:
schema:
type: string
example: '*'
Access-Control-Allow-Methods:
schema:
type: string
example: 'GET, POST, PUT, PATCH, DELETE, OPTIONS'
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
X-Request-Id:
schema:
type: string
example: 0c74d761-be9c-4436-bf38-b88830b19b2e
Date:
schema:
type: string
example: 'Tue, 02 Apr 2024 01:51:46 GMT'
Content-Length:
schema:
type: integer
example: 562
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
/casts:
get:
tags:
- default
summary: Casts
parameters:
- name: fid
in: query
description: Returns casts from a specific FID
schema:
type: integer
example: 4823
examples:
default:
value: 4823
- name: following
in: query
description: 'When used in combination of `fid` will return the casts for who that `fid` is following '
schema:
type: boolean
example: true
examples:
default:
value: true
- name: reverse
in: query
description: 'Will reverse the results giving the most casts recent first'
schema:
type: boolean
example: true
examples:
default:
value: false
- name: channel
in: query
description: Specify a channel to fetch casts from
schema:
type: string
example: 'pinata'
examples:
default:
value: 'pinata'
- name: parentHash
in: query
description: Returns casts for a specific parent hash
schema:
type: string
example: '0x0ab851ba8524eedf9e164b55f6eeec751f74b539'
examples:
default:
value: '0x0ab851ba8524eedf9e164b55f6eeec751f74b539'
- name: pageToken
in: query
description: Token to be used for the next page of results
schema:
type: string
example: eyJvZmZzZXQiOiIwIn0
examples:
default:
value: eyJvZmZzZXQiOiIwIn0
- name: topLevel
in: query
description: Filter casts that have no parent hash
schema:
type: boolean
example: true
examples:
default:
value: true
- name: pageSize
in: query
description: 'Determine the number of results, if not specified default is 100'
schema:
type: integer
example: 10
examples:
default:
value: 10
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
example-0:
summary: Casts by FID
value:
casts:
- author:
active_status: inactive
custody_address: '0x7f9a6992a54dc2f23f1105921715bd61811e5b71'
display_name: Justin Hunter
fid: 4823
follower_count: 26787
following_count: 924
object: user
pfp_url: >-
https://i.seadn.io/gae/lhGgt7yK1JiBVYz_HBxcAmYLRtP03aw5xKX4FgmFT9Ai7kLD5egzlLvb0lkuRNl28shtjr07DC8IHzLUkTqlWUMndUzC9R5_MSxH3g?w=500&auto=format
power_badge: true
profile:
bio:
mentioned_profiles: []
text: >-
Writer. Building @pinatacloud. Tinkering with a
Farcaster native alternative to GoodReads:
https://readcast.xyz \
https://polluterofminds.com
username: polluterofminds
verifications:
- '0xcdcdc174901b12e87cc82471a2a2bd6181c89392'
- '0x1612c6dff0eb5811108b709a30d8150495ce9cc5'
verified_addresses:
eth_addresses:
- '0xcdcdc174901b12e87cc82471a2a2bd6181c89392'
- '0x1612c6dff0eb5811108b709a30d8150495ce9cc5'
sol_addresses: []
embeds:
- url: >-
https://x.com/matthew_d_green/status/1789687898863792453?s=46
hash: '0xddc971b2ae7188c739627cc3ff519f1a5ce0ffde'
mentioned_profiles: []
object: cast
parent_author:
fid: null
parent_hash: null
parent_url: https://warpcast.com/~/channel/privacy
reactions:
likes:
- fid: 2777
fname: alexbruno.eth
- fid: 533877
fname: bura7501
- fid: 288646
fname: sebek
- fid: 5491
fname: pauldowman.eth
- fid: 5016
fname: stas
likes_count: 7
recasts:
- fid: 533877
fname: bura7501
- fid: 5016
fname: stas
recasts_count: 2
replies:
count: 2
root_parent_url: https://warpcast.com/~/channel/privacy
text: >-
Telegram has never made much sense to me. But I’ve
largely resigned myself to having lost the battle in
crypto and am forced to use it daily.
https://x.com/matthew_d_green/status/1789687898863792453?s=46
thread_hash: '0xddc971b2ae7188c739627cc3ff519f1a5ce0ffde'
timestamp: '2024-05-13T13:30:18.000Z'
next:
cursor: >-
eyJ0aW1lc3RhbXAiOiIyMDI0LTA1LTEzIDEzOjMwOjE4LjAwMDAwMDAifQ%3D%3D
example-1:
summary: Casts by Channel
value:
casts:
- author:
active_status: inactive
custody_address: '0x535077f17fa51a4f65924e87ac131152d8b5b350'
display_name:
fid: 229150
follower_count: 9299
following_count: 327
object: user
pfp_url: https://i.imgur.com/yH5XzZj.png
power_badge: true
profile:
bio:
mentioned_profiles: []
text: >-
software engineer & cto - building /sukuri -
foss advocate - creator of /frame-token -
maxbridgland.twitter
username: maxbr
verifications:
- '0x44f6498d1403321890f3f2917e00f22dbde3577a'
- '0xf88e4a3af660ab09979a33c3c99e576244dda5af'
verified_addresses:
eth_addresses:
- '0x44f6498d1403321890f3f2917e00f22dbde3577a'
- '0xf88e4a3af660ab09979a33c3c99e576244dda5af'
sol_addresses: []
embeds:
- cast_id:
fid: 229150
hash: '0xf3f233c1ca2b2fa68d8803a90c29976953224234'
hash: '0xd1c32f0b14a4a1f489ef1ef98f140686f82da2e0'
mentioned_profiles: []
object: cast
parent_author:
fid: null
parent_hash: null
parent_url: https://warpcast.com/~/channel/pinata
reactions:
likes:
- fid: 5818
fname: adriennetenger.eth
- fid: 262634
fname: data-nerd
- fid: 367295
fname: aft3rparty.eth
- fid: 6023
fname: stevedylandev.eth
- fid: 4823
fname: polluterofminds
likes_count: 7
recasts: []
recasts_count: 0
replies:
count: 1
root_parent_url: https://warpcast.com/~/channel/pinata
text: >-
Big shoutout to /pinata for their Managed Farcaster
Auth system
I haven't been able to figure this out for months
until I came across their product tucked away in a
blogpost somewhere. Google needs to rank it higher
thread_hash: '0xd1c32f0b14a4a1f489ef1ef98f140686f82da2e0'
timestamp: '2024-05-11T17:19:35.000Z'
next:
cursor: >-
eyJ0aW1lc3RhbXAiOiIyMDI0LTA1LTExIDE3OjE5OjM1LjAwMDAwMDAifQ%3D%3D
headers:
Date:
schema:
type: string
example: 'Sat, 09 Mar 2024 20:10:12 GMT'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Content-Length:
schema:
type: integer
example: 1696
Connection:
schema:
type: string
example: keep-alive
X-Request-Id:
schema:
type: string
example: 7e395721013189607fb6d458e522efbd
Strict-Transport-Security:
schema:
type: string
example: max-age=15724800; includeSubDomains
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
post:
tags:
- default
summary: Send Cast
requestBody:
content:
application/json:
schema:
type: object
properties:
castAddBody:
type: object
properties:
text:
type: string
parentUrl:
type: string
embeds:
type: array
items:
type: object
properties:
url:
type: string
castId:
type: object
properties:
fid:
type: integer
hash:
type: string
mentions:
type: array
items:
type: integer
mentionsPositions:
type: array
items:
type: integer
parentCastId:
type: object
properties:
fid:
type: integer
hash:
type: string
signerId:
type: string
x-examples:
Example 1:
castAddBody:
text: Hello World!
parentUrl: 'https://warpcast.com/~/channel/pinata'
embeds:
- url: 'https://dweb.mypinata.cloud/ipfs/QmYSzs7WczucVrPN2CZcZeEzyGRDrxrFEWGtYA32jz2L3U?filename=sendit.gif'
- castId:
fid: 6023
hash: '0xb3668292af912397fad6b8457223e75c04221992'
mentions:
- 6023
mentionsPositions:
- 2
parentCastId:
fid: 6023
hash: '0xb3668292af912397fad6b8457223e75c04221992'
signerId: e5cf5d84-7671-4402-8df0-84b0efdc24cd
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
data:
data:
type: MESSAGE_TYPE_CAST_ADD
fid: 401191
timestamp: 102505958
network: FARCASTER_NETWORK_MAINNET
castAddBody:
embedsDeprecated: []
mentions: []
text: Hello World!
mentionsPositions: []
embeds: []
hash: '0xb3668292af912397fad6b8457223e75c04221992'
hashScheme: HASH_SCHEME_BLAKE3
signature: U40EB6YqZNI/AdNrXLyk7jjh+U/XdHe6fWTX28IDX6PJQTfG+7cJX/dUtrOzNfvCojEUqaaks3a+oPBPU7jVAw==
signatureScheme: SIGNATURE_SCHEME_ED25519
signer: '0x86367a36c3c181c46acdc6027109dbaa75c5fbc97c500af23f1ea8c987f12375'
dataBytes: CAEQp74YGOa78DAgASoOIgxIZWxsbyBXb3JsZCE=
headers:
Access-Control-Allow-Headers:
schema:
type: string
example: '*'
Access-Control-Allow-Methods:
schema:
type: string
example: 'GET, POST, PUT, PATCH, DELETE, OPTIONS'
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
X-Request-Id:
schema:
type: string
example: da219420-e592-4727-81a9-2261cbf379c8
Date:
schema:
type: string
example: 'Mon, 01 Apr 2024 09:52:39 GMT'
Content-Length:
schema:
type: integer
example: 600
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
'/casts/{hash}/reactions/{type}':
post:
tags:
- default
summary: Add Reaction to Cast
parameters:
- name: signerId
in: query
description: Signer ID for the user that will react to the cast
required: true
schema:
type: string
example: e5cf5d84-7671-4402-8df0-84b0efdc24cd
examples:
default:
value: e5cf5d84-7671-4402-8df0-84b0efdc24cd
- name: hash
in: path
description: Hash for the target cast
required: true
schema:
type: string
example: '0x5e6116e836746bb0264b217435f6668d9c9259bd'
examples:
default:
value: '0x5e6116e836746bb0264b217435f6668d9c9259bd'
- name: type
in: path
description: 'The type of reaction, can be either "like" or "recast"'
required: true
schema:
type: string
example: like
examples:
default:
value: like
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
data:
data:
type: MESSAGE_TYPE_REACTION_ADD
fid: 401191
timestamp: 102564007
network: FARCASTER_NETWORK_MAINNET
castAddBody:
embedsDeprecated: null
mentions: null
hash: '0xe1d3327a7d00a23e76207bbf8ef6ca17b9c39d9c'
hashScheme: HASH_SCHEME_BLAKE3
signature: AYW+pBiRxszYDilJ2RUkeNarIgzUDFpuYc5cSlGk2lSgVa4yubiqfqArsqHxIXtzjRgHODN8E8qGClyuxMkbAg==
signatureScheme: SIGNATURE_SCHEME_ED25519
signer: '0x86367a36c3c181c46acdc6027109dbaa75c5fbc97c500af23f1ea8c987f12375'
dataBytes: CAMQp74YGKeB9DAgATodCAESGQiHLxIUXmEW6DZ0a7AmSyF0NfZmjZySWb0=
headers:
Access-Control-Allow-Headers:
schema:
type: string
example: '*'
Access-Control-Allow-Methods:
schema:
type: string
example: 'GET, POST, PUT, PATCH, DELETE, OPTIONS'
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
X-Request-Id:
schema:
type: string
example: 5a725c5b-e124-4244-8854-2b35610fb2e4
Date:
schema:
type: string
example: 'Tue, 02 Apr 2024 02:00:07 GMT'
Content-Length:
schema:
type: integer
example: 571
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
delete:
tags:
- default
summary: Delete Reaction to Cast
parameters:
- name: signerId
in: query
description: Signer ID for the user that will remove reaction to the cast
required: true
schema:
type: string
example: e5cf5d84-7671-4402-8df0-84b0efdc24cd
examples:
default:
value: e5cf5d84-7671-4402-8df0-84b0efdc24cd
- name: hash
in: path
description: Hash for the target cast
required: true
schema:
type: string
example: '0x5e6116e836746bb0264b217435f6668d9c9259bd'
examples:
default:
value: '0x5e6116e836746bb0264b217435f6668d9c9259bd'
- name: type
in: path
description: 'The type of reaction, can be either "like" or "recast"'
required: true
schema:
type: string
example: like
examples:
default:
value: like
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
data:
data:
type: MESSAGE_TYPE_REACTION_REMOVE
fid: 401191
timestamp: 102564096
network: FARCASTER_NETWORK_MAINNET
castAddBody:
embedsDeprecated: null
mentions: null
hash: '0x6df38d410d8c63d3dd9514ffc463d0b7690194c5'
hashScheme: HASH_SCHEME_BLAKE3
signature: CKC9iuQ2UbJDdiOF49ZuBkXuwaAZDyYjDBnPjuVrM9hnNP2jO3e19icwqh+kgCvxoTExahvYkBVBDA38pcwmBQ==
signatureScheme: SIGNATURE_SCHEME_ED25519
signer: '0x86367a36c3c181c46acdc6027109dbaa75c5fbc97c500af23f1ea8c987f12375'
dataBytes: CAQQp74YGICC9DAgATodCAESGQiHLxIUXmEW6DZ0a7AmSyF0NfZmjZySWb0=
headers:
Access-Control-Allow-Headers:
schema:
type: string
example: '*'
Access-Control-Allow-Methods:
schema:
type: string
example: 'GET, POST, PUT, PATCH, DELETE, OPTIONS'
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
X-Request-Id:
schema:
type: string
example: 7e7f6589-7038-4348-b428-e3f80eecaed2
Date:
schema:
type: string
example: 'Tue, 02 Apr 2024 02:01:36 GMT'
Content-Length:
schema:
type: integer
example: 574
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
/channels:
get:
tags:
- default
summary: Channels List
parameters:
- name: pageSize
in: query
description: 'Determine the number of results, if not specified default is 100'
schema:
type: integer
example: 1
examples:
default:
value: 1
- name: pageToken
in: query
description: Token to be used for the next page of results
schema:
type: string
example: eyJvZmZzZXQiOiIxMyJ9
examples:
default:
value: eyJvZmZzZXQiOiIxMyJ9
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
channels:
- created_at: 1715609736
description: a place for sharing and discussing longform stories online
follower_count: 1
hosts:
- active_status: inactive
custody_address: '0xb6620b05a422658688d57b5158d464dea912879d'
display_name: Vinay Vasanji
fid: 1082
follower_count: 2800
following_count: 1237
notes:
active_status: >-
Warpcast has transitioned from active badges to
power badges, Neynar will deprecate this key in the
user object in the next few weeks
object: user
pfp_url: https://i.imgur.com/7y4JRTk.jpg
power_badge: true
profile:
bio:
text: >-
/cryptocandies founder everyname.xyz (acq.)
cofounder humanetics.super.site
username: vinayvasanji.eth
verifications:
- '0x12c6920a4acc4dae6b3992903a48adcbffe5dc5e'
verified_addresses:
eth_addresses:
- '0x12c6920a4acc4dae6b3992903a48adcbffe5dc5e'
sol_addresses:
- BheMt83LxwReoARkU4Q4cE67ksZzA7Rf9E3ABdVZpUEy
id: longreads
image_url: https://i.imgur.com/AMxg3Jh.png
lead:
active_status: inactive
custody_address: '0xb6620b05a422658688d57b5158d464dea912879d'
display_name: Vinay Vasanji
fid: 1082
follower_count: 2800
following_count: 1237
notes:
active_status: >-
Warpcast has transitioned from active badges to power
badges, Neynar will deprecate this key in the user
object in the next few weeks
object: user
pfp_url: https://i.imgur.com/7y4JRTk.jpg
power_badge: true
profile:
bio:
text: >-
/cryptocandies founder everyname.xyz (acq.)
cofounder humanetics.super.site
username: vinayvasanji.eth
verifications:
- '0x12c6920a4acc4dae6b3992903a48adcbffe5dc5e'
verified_addresses:
eth_addresses:
- '0x12c6920a4acc4dae6b3992903a48adcbffe5dc5e'
sol_addresses:
- BheMt83LxwReoARkU4Q4cE67ksZzA7Rf9E3ABdVZpUEy
name: longreads
object: channel
parent_url: https://warpcast.com/~/channel/longreads
url: https://warpcast.com/~/channel/longreads
next:
cursor: eyJwYWdlIjoyfQ%3D%3D
headers:
Date:
schema:
type: string
example: 'Sat, 09 Mar 2024 20:11:20 GMT'
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
Content-Length:
schema:
type: integer
example: 296
Connection:
schema:
type: string
example: keep-alive
X-Request-Id:
schema:
type: string
example: f7dbd4cc572c4c5fe673a7be66311f65
Strict-Transport-Security:
schema:
type: string
example: max-age=15724800; includeSubDomains
security:
- bearerAuth: []
servers:
- url: 'https://api.pinata.cloud/v3/farcaster'
'/channels/{name}':
get:
tags:
- default
summary: Channel By Name
parameters:
- name: name
in: path
description: Display name for the channel you are trying to fetch
required: true
schema:
type: string
example: pinata
examples:
default:
value: pinata
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
default:
value:
channel:
created_at: 1706890562
description: >-
Build on IPFS and Farcaster at Scale |
https://docs.pinata.cloud/farcaster/farcaster-api/getting-started
follower_count: 544
hosts:
- active_status: inactive
custody_address: '0x62402434701e0ce0ae4ea4b3caf68230a6ddbe43'
display_name: Kyle Tut
fid: 20591
follower_count: 473
following_count: 22
notes:
active_status: >-
Warpcast has transitioned from active badges to power
badges, Neynar will deprecate this key in the user
object in the next few weeks
object: user
pfp_url: https://i.imgur.com/TLMFnH6.jpg
power_badge: true
profile:
bio:
text: >-
Everyone is from somewhere. Cofounder and CEO of
Pinata. https://www.pinata.cloud/farcaster
username: kyletut
verifications:
- '0x5ba9355a10611ed4339526472a59befed3549bad'
verified_addresses:
eth_addresses:
- '0x5ba9355a10611ed4339526472a59befed3549bad'
sol_addresses: []
- active_status: inactive
custody_address: '0x7f9a6992a54dc2f23f1105921715bd61811e5b71'
display_name: Justin Hunter
fid: 4823