-
Notifications
You must be signed in to change notification settings - Fork 0
/
Pixiv App API.yaml
1571 lines (1418 loc) · 33.8 KB
/
Pixiv App API.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
swagger: '2.0'
info:
title: "Pixiv App API"
description: "Unofficial API specification extracted from Pixiv Android App v5.0.17"
version: "1.0"
host: app-api.pixiv.net
schemes:
- https
produces:
- application/json
consumes:
- application/x-www-form-urlencoded;charset=UTF-8
definitions:
GenericError:
type: object
description: "Error message"
properties:
error:
type: string
ValidationError:
type: object
description: "Various field errors"
properties:
error:
type: object
additionalProperties:
type: array
items:
type: string
NextUrl:
type: string
description: "Url to the next page"
format: uri
x-nullable: true
ImageUrls:
type: object
description: "Urls for the different sizes of picture"
properties:
original:
type: string
format: uri
large:
type: string
format: uri
medium:
type: string
format: uri
small: # noqa
type: string
square_medium:
type: string
format: uri
max_240x240: # noqa
type: string
px_120x: # noqa
type: string
px_128x128:
type: string
format: uri
px_16x16: # noqa
type: string
px_170x170: # noqa
type: string
px_480mw: # noqa
type: string
px_48x48: # noqa
type: string
px_50x50: # noqa
type: string
px_56x56:
type: string
format: uri
px_64x64: # noqa
type: string
ugoira600x600: # noqa
type: string
ugoira1920x1080: # noqa
type: string
ApplicationInfo:
type: object
properties:
notice_exists:
type: boolean
notice_id:
type: string
notice_important:
type: boolean
notice_message:
type: string
store_url:
type: string
update_available:
type: boolean
update_message:
type: string
update_required:
type: boolean
ApplicationInfoWrapper:
type: object
required: ["application_info"]
properties:
application_info:
$ref: "#/definitions/ApplicationInfo"
Emoji:
type: object
properties:
image_url_medium:
type: string
format: uri
image_urls:
$ref: "#/definitions/ImageUrls"
slug:
type: string
EmojisWrapper:
type: object
properties:
emoji_definitions:
type: array
items:
$ref: "#/definitions/Emoji"
RenewalDescription:
type: object
description: "Changelog"
properties:
change_points:
type: array
items:
type: string
description:
type: string
RenewalDescriptionWrapper:
type: object
properties:
renewal_description:
$ref: "#/definitions/RenewalDescription"
UserState:
type: object
description: "User state"
properties:
is_mail_authorized:
type: boolean
UserStateWrapper:
type: object
properties:
user_state:
$ref: "#/definitions/UserState"
Workspace:
type: object
description: "Workspace"
properties:
chair:
description: "Chair"
type: string
comment:
description: "Others"
type: string
desk:
description: "Table"
type: string
desktop:
description: "On top of your desk"
type: string
monitor:
description: "Monitor"
type: string
mouse:
description: "Mouse"
type: string
music:
description: "Drawing tunes"
type: string
pc:
description: "Computer"
type: string
printer:
description: "Printer"
type: string
scanner:
description: "Scanner"
type: string
tablet:
description: "Graphic tablet"
type: string
tool:
description: "Software used"
type: string
workspace_image_url:
description: "Full sized workspace photo"
type: string
format: uri
x-nullable: true
User:
type: object
description: "Pixiv user"
required:
- account
- id
- is_followed
- name
- profile_image_urls
properties:
account:
description: "User login"
type: string
comment:
description: "Self introduction"
type: string
id:
description: "User ID"
type: integer
is_followed:
type: boolean
name:
description: "Nickname"
type: string
profile_image_urls:
$ref: "#/definitions/ImageUrls"
Profile:
type: object
description: "Pixiv user profile"
properties:
background_image_url:
description: "Full sized workspace photo"
type: string
format: uri
x-nullable: true
birth:
description: "Birthday"
type: string
pattern: "yyyy-MM-dd"
gender:
description: "Gender"
type: string
enum: ["male", "female"]
job:
description: "Occupation"
type: string
region:
description: "Location"
type: string
total_follow_users:
type: integer
total_follower:
type: integer
total_illusts:
type: integer
total_manga:
type: integer
total_mypixiv_users:
type: integer
total_novels:
type: integer
twitter_account:
type: string
twitter_url:
description: "Twitter"
type: string
format: uri
x-nullable: true
webpage:
description: "Website"
type: string
format: uri
x-nullable: true
UserDetailWrapper:
type: object
properties:
profile:
$ref: "#/definitions/Profile"
user:
$ref: "#/definitions/User"
workspace:
$ref: "#/definitions/Workspace"
UserFollowDetailWrapper:
type: object
properties:
follow_detail:
type: object
properties:
is_followed:
type: boolean
restrict:
type: string
enum: ["public", "private"]
UserPreview:
type: object
properties:
illusts:
type: array
items:
$ref: "#/definitions/Illust"
novels:
type: array
items:
$ref: "#/definitions/Novel"
user:
$ref: "#/definitions/User"
UserPreviewsWrapper:
type: object
properties:
next_url:
$ref: "#/definitions/NextUrl"
user_previews:
type: array
items:
$ref: "#/definitions/UserPreview"
Tag:
type: object
required:
- name
properties:
count:
type: integer
is_registered:
type: boolean
name:
type: string
Restrict:
type: integer
description: |
Content rating.
0 => All;
1 => R18;
2 => R18G;
enum: [0, 1, 2]
SanityLevel: # SEO-related, maybe?
type: integer
description: |
0 => Unchecked;
1 => Gray;
2 => White;
4 => Semi black;
6 => Black;
enum: [0, 1, 2, 4, 6]
Illust:
type: object
properties:
id:
type: integer
user:
$ref: "#/definitions/User"
visible:
type: boolean
is_bookmarked:
type: boolean
title:
description: "Title"
type: string
caption:
description: "Description"
type: string
create_date:
description: "Date created"
type: string
format: date-time
width:
type: integer
height:
type: integer
tools:
type: array
description: "Software used"
items:
type: string
total_bookmarks:
type: integer
total_comments:
type: integer
total_view:
type: integer
type:
type: string
enum: ["illust", "manga", "ugoira"]
tags:
type: array
items:
$ref: "#/definitions/Tag"
image_urls:
$ref: "#/definitions/ImageUrls"
meta_pages:
type: array
items:
type: object
properties:
image_urls:
$ref: "#/definitions/ImageUrls"
meta_single_page:
type: object
properties:
original_image_url:
type: string
format: uri
page_count:
type: integer
restrict:
$ref: "#/definitions/Restrict"
sanity_level:
$ref: "#/definitions/SanityLevel"
IllustWrapper:
type: object
properties:
illust:
$ref: "#/definitions/Illust"
IllustsWrapper:
type: object
properties:
illusts:
type: array
items:
$ref: "#/definitions/Illust"
next_url:
$ref: "#/definitions/NextUrl"
IllustLabel:
type: object
properties:
title:
type: string
width:
type: integer
height:
type: integer
user_name:
type: string
image_urls:
$ref: "#/definitions/ImageUrls"
IllustsRecomendedWrapper:
type: object
required:
- next_url
- illusts
properties:
home_ranking_illusts:
type: array
items:
$ref: "#/definitions/Illust"
illusts:
type: array
items:
$ref: "#/definitions/Illust"
next_url:
$ref: "#/definitions/NextUrl"
ranking_label_illust:
$ref: "#/definitions/IllustLabel"
Series:
type: object
description: "Series description"
properties:
id:
type: integer
title:
type: string
Novel:
type: object
properties:
id:
type: integer
user:
$ref: "#/definitions/User"
visible:
type: boolean
is_bookmarked:
type: boolean
title:
description: "Title"
type: string
caption:
description: "Description"
type: string
create_date:
description: "Date created"
type: string
format: date-time
text_length:
type: integer
total_bookmarks:
type: integer
total_comments:
type: integer
total_view:
type: integer
tags:
type: array
items:
$ref: "#/definitions/Tag"
image_urls:
$ref: "#/definitions/ImageUrls"
series:
$ref: "#/definitions/Series"
page_count:
type: integer
restrict:
$ref: "#/definitions/Restrict"
NovelWrapper:
type: object
properties:
novel:
$ref: "#/definitions/Novel"
NovelsWrapper:
type: object
properties:
next_url:
$ref: "#/definitions/NextUrl"
novels:
type: array
items:
$ref: "#/definitions/Novel"
NovelTextWrapper:
type: object
properties:
novel_marker:
type: object
properties:
page:
type: integer
novel_text:
type: string
series_next:
$ref: "#/definitions/Novel"
series_prev:
$ref: "#/definitions/Novel"
NovelLabel:
type: object
properties:
image_urls:
$ref: "#/definitions/ImageUrls"
title:
type: string
user_name:
type: string
NovelsRecomendedWrapper:
type: object
properties:
home_ranking_novels:
type: array
items:
$ref: "#/definitions/Novel"
next_url:
$ref: "#/definitions/NextUrl"
novels:
type: array
items:
$ref: "#/definitions/Novel"
ranking_label_novel:
$ref: "#/definitions/NovelLabel"
UgoiraFrame:
type: object
properties:
delay:
description: "Delay (in msec) before switching to the next frame"
type: integer
file:
description: "Frame filename"
type: string
Ugoira:
type: object
properties:
frames:
type: array
items:
$ref: "#/definitions/UgoiraFrame"
zip_urls:
$ref: "#/definitions/ImageUrls"
UgoiraWrapper:
type: object
properties:
ugoira_metadata:
$ref: "#/definitions/Ugoira"
BookmarkDetail:
type: object
properties:
is_bookmarked:
type: boolean
restrict:
type: string
enum: ["all", "public", "private"]
tags:
type: array
items:
$ref: "#/definitions/Tag"
BookmarkDetailWrapper:
type: object
properties:
bookmark_detail:
$ref: "#/definitions/BookmarkDetail"
BookmarkTagsWrapper:
type: object
properties:
bookmark_tags:
type: array
items:
$ref: "#/definitions/Tag"
next_url:
$ref: "#/definitions/NextUrl"
Comment:
type: object
properties:
comment:
type: string
date:
type: string
format: date-time
id:
type: integer
user:
$ref: "#/definitions/User"
CommentsWrapper:
type: object
properties:
comments:
type: array
items:
$ref: "#/definitions/Comment"
next_url:
$ref: "#/definitions/NextUrl"
total_comments:
type: integer
SpotlightArticle:
type: object
properties:
id:
type: integer
title:
type: string
publish_date:
type: string
format: date-time
thumbnail:
type: string
format: uri
article_url:
type: string
format: uri
SpotlightArticlesWrapper:
type: object
properties:
spotlight_articles:
type: array
items:
$ref: "#/definitions/SpotlightArticle"
next_url:
$ref: "#/definitions/NextUrl"
SearchAutocompleteWrapper:
type: object
properties:
search_auto_complete_keywords:
type: array
items:
type: string
responses:
NotDocumented:
description: "TBD"
schema:
type: string
GenericError:
description: "Generic error"
schema:
$ref: "#/definitions/GenericError"
ValidationError:
description: "Validation error"
schema:
$ref: "#/definitions/ValidationError"
ApplicationInfoOK:
description: OK
schema:
$ref: "#/definitions/ApplicationInfoWrapper"
EmojisOK:
description: OK
schema:
$ref: "#/definitions/EmojisWrapper"
RenewalDescriptionOK:
description: OK
schema:
$ref: "#/definitions/RenewalDescriptionWrapper"
UserStateOK:
description: OK
schema:
$ref: "#/definitions/UserStateWrapper"
UserDetailOK:
description: OK
schema:
$ref: "#/definitions/UserDetailWrapper"
UserFollowDetailOK:
description: OK
schema:
$ref: "#/definitions/UserFollowDetailWrapper"
UserPreviewsOK:
description: OK
schema:
$ref: "#/definitions/UserPreviewsWrapper"
UgoiraMetadataOK:
description: OK
schema:
$ref: "#/definitions/UgoiraWrapper"
IllustOK:
description: OK
schema:
$ref: "#/definitions/IllustWrapper"
IllustsOK:
description: OK
schema:
$ref: "#/definitions/IllustsWrapper"
IllustsRecomendedOK:
description: OK
schema:
$ref: "#/definitions/IllustsRecomendedWrapper"
NovelOK:
description: OK
schema:
$ref: "#/definitions/NovelWrapper"
NovelsOK:
description: OK
schema:
$ref: "#/definitions/NovelsWrapper"
NovelTextOK:
description: OK
schema:
$ref: "#/definitions/NovelTextWrapper"
NovelsRecomendedOK:
description: OK
schema:
$ref: "#/definitions/NovelsRecomendedWrapper"
BookmarkDetailOK:
description: OK
schema:
$ref: "#/definitions/BookmarkDetailWrapper"
BookmarkTagsOK:
description: OK
schema:
$ref: "#/definitions/BookmarkTagsWrapper"
CommentsOK:
description: OK
schema:
$ref: "#/definitions/CommentsWrapper"
SpotlightArticlesOK:
description: OK
schema:
$ref: "#/definitions/SpotlightArticlesWrapper"
SearchAutocompleteOK:
description: OK
schema:
$ref: "#/definitions/SearchAutocompleteWrapper"
parameters:
Authorization:
name: Authorization
description: "OAuth2 Bearer"
type: string
in: header
required: true
Offset:
name: offset
description: "Offset for pagination"
type: integer
in: query
required: false
Restrict:
name: restrict
description: "Visibility type (e.g. in bookmarks)"
type: string
in: query
enum: ["public", "private", "all"]
UserID:
name: user_id
description: "User ID"
type: integer
in: query
SeedUserID:
name: seed_user_id
description: "User ID seed"
type: integer
in: query
IllustID:
name: illust_id
description: "Illustration ID"
type: integer
in: query
NovelID:
name: novel_id
description: "Novel ID"
type: integer
in: query
NovelSeriesId:
name: series_id
description: "Novel series ID"
type: integer
in: query
RankingMode:
name: mode
description: "Ranking mode"
type: string
in: query
enum: ["day", "day_male", "day_female", "week_original", "week_rookie", "week", "month", "day_r18", "week_r18", "day_male_r18", "day_female_r18", "week_r18g", "week_rookie_manga", "week_manga", "month_manga", "day_r18_manga", "week_r18_manga", "week_r18g_manga"]
RankingModeNovel:
name: mode
description: "Ranking mode"
type: string
in: query
enum: ["day", "day_male", "day_female", "week_rookie", "week day_r18", "week_r18"]
RankingDate: # noqa
name: date
description: "Ranking for a specific day"
type: string
in: query
pattern: "yyyy-MM-dd"
Tag: # noqa
name: tag
description: "Tag"
type: string
in: query
ContentType:
name: content_type
description: "Content Type"
type: string
in: query
enum: ["illust", "manga", "novel", "user"]
IncludeRanking:
name: include_ranking
description: "Include ranking"
type: boolean
in: query
default: false
IncludeRankingLabel:
name: include_ranking_label
description: "Include ranking label"
type: boolean
in: query
default: false
MinBookmarkIdForRecentIllust:
name: min_bookmark_id_for_recent_illust
description: "N/A"
type: integer
in: query
MaxBookmarkIdForRecommend:
name: max_bookmark_id_for_recommend
description: "N/A"
type: integer
in: query
MaxBookmarkId:
name: max_bookmark_id
description: "N/A"
type: integer
in: query
MinSeriesItemId:
name: min_series_item_id
description: "N/A"
type: integer
in: query
BookmarkIllustIDs:
name: bookmark_illust_ids
description: "Comma separated list of work ids"
type: array
in: query
allowEmptyValue: true
items:
type: integer
collectionFormat: csv
BookmarkNovelIDs:
name: bookmark_novel_ids
description: "Comma separated list of novel ids"
type: array
in: query
allowEmptyValue: true
items:
type: integer
collectionFormat: csv
SearchWord:
name: word
description: "Search keyword"
type: string
in: query
required: true
SearchSort:
name: sort
description: "Search result order"
type: string
in: query
enum: ["date_desc", "date_asc", "popular_desc"]
SearchTarget:
name: search_target
description: "Where to search"
type: string
in: query
enum: ["partial_match_for_tags", "exact_match_for_tags", "title_and_caption", "text", "keyword"]
SearchBookmarkNum:
name: bookmark_num
description: |
0 => 0;
1 => 10;
2 => 30;
3 => 50;
4 => 100;
5 => 300;
6 => 500;
7 => 1000;
8 => 5000;
type: integer
in: query
enum: [0, 1, 2, 3, 4, 5, 6, 7, 8]
SearchDuration:
name: duration
description: "Search for certain period of time"
type: string
in: query
allowEmptyValue: true
enum: ["within_last_day", "within_last_week", "within_last_month"]