Metron
Metron
Client for the Metron comic-book database API.
Handles authentication, rate limiting, caching, and response validation for all requests made to the Metron REST API.
| PARAMETER | DESCRIPTION |
|---|---|
username
|
Metron account username used for HTTP Basic authentication.
TYPE:
|
password
|
Metron account password used for HTTP Basic authentication.
TYPE:
|
cache
|
Path to the SQLite cache file.
If not provided, a default path will be used under
TYPE:
|
base_url
|
Root URL of the Metron API.
TYPE:
|
user_agent
|
Value sent in the
TYPE:
|
timeout
|
Number of seconds to wait for a server response before timing out.
TYPE:
|
cache_expiry
|
Duration for which cached responses are valid. Response cache-headers take precedence.
TYPE:
|
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
Functions
get_arc
Retrieve detailed information about a story arc by ID.
| PARAMETER | DESCRIPTION |
|---|---|
arc_id
|
The unique identifier of the arc.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Arc
|
An Arc object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | |
get_character
Retrieve detailed information about a character by ID.
| PARAMETER | DESCRIPTION |
|---|---|
character_id
|
The unique identifier of the character.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Character
|
A Character object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | |
get_collection
Retrieve detailed information about a collection item by ID.
Note: This endpoint requires authentication. Users can only access their own collection items.
| PARAMETER | DESCRIPTION |
|---|---|
collection_id
|
The unique identifier of the collection entry.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Collection
|
A Collection object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | |
get_collection_stats
Retrieve statistics about the authenticated user's collection.
Returns comprehensive statistics including total items, total value, read/unread counts, and breakdowns by format. Note: This endpoint requires authentication.
| RETURNS | DESCRIPTION |
|---|---|
CollectionStats
|
A CollectionStats object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | |
get_creator
Retrieve detailed information about a creator by ID.
| PARAMETER | DESCRIPTION |
|---|---|
creator_id
|
The unique identifier of the creator.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Creator
|
A Creator object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
get_imprint
Retrieve detailed information about an imprint by ID.
| PARAMETER | DESCRIPTION |
|---|---|
imprint_id
|
The unique identifier of the imprint.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Imprint
|
An Imprint object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 | |
get_issue
Retrieve detailed information about an issue by ID.
| PARAMETER | DESCRIPTION |
|---|---|
issue_id
|
The unique identifier of the issue.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Issue
|
An Issue object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 | |
get_publisher
Retrieve detailed information about a publisher by ID.
| PARAMETER | DESCRIPTION |
|---|---|
publisher_id
|
The unique identifier of the publisher.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Publisher
|
A Publisher object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 | |
get_reading_list
Retrieve detailed information about a reading list by ID.
| PARAMETER | DESCRIPTION |
|---|---|
reading_list_id
|
The unique identifier of the reading list.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
ReadingList
|
A ReadingList object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 | |
get_series
Retrieve detailed information about a series by ID.
| PARAMETER | DESCRIPTION |
|---|---|
series_id
|
The unique identifier of the series.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Series
|
A Series object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 | |
get_team
Retrieve detailed information about a team by ID.
| PARAMETER | DESCRIPTION |
|---|---|
team_id
|
The unique identifier of the team.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Team
|
A Team object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 | |
get_universe
Retrieve detailed information about a universe by ID.
| PARAMETER | DESCRIPTION |
|---|---|
universe_id
|
The unique identifier of the universe.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Universe
|
A Universe object. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 | |
list_arc_issues
Retrieve a list of issues that are part of a specific story arc.
| PARAMETER | DESCRIPTION |
|---|---|
arc_id
|
The unique identifier of the arc.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonIssue]
|
A list of CommonIssue objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | |
list_arcs
Retrieve a list of story arcs with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return arcs modified after this datetime.
TYPE:
|
name
|
Filter arcs by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing arcs. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_character_issues
Retrieve a list of issues featuring a specific character.
| PARAMETER | DESCRIPTION |
|---|---|
character_id
|
The unique identifier of the character.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonIssue]
|
A list of CommonIssue objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 | |
list_characters
Retrieve a list of characters with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return characters modified after this datetime.
TYPE:
|
name
|
Filter characters by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing characters. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_collection_missing_issues
Retrieve a list of missing issues for a specific series.
Returns issues from a series that are not in the authenticated user's collection. Note: This endpoint requires authentication.
| PARAMETER | DESCRIPTION |
|---|---|
series_id
|
The unique identifier of the series.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BaseIssue]
|
A list of BaseIssue objects representing missing issues. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 | |
list_collection_missing_series
Retrieve a list of series where the user has some issues but is missing others.
Returns series where the authenticated user owns at least one issue but not all issues in the series. Note: This endpoint requires authentication.
| RETURNS | DESCRIPTION |
|---|---|
list[MissingSeries]
|
A list of MissingSeries objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 | |
list_collections
Retrieve a list of collection items with optional filtering.
Note: This endpoint requires authentication. Users can only access their own collection items.
| PARAMETER | DESCRIPTION |
|---|---|
book_format
|
Filter by the format of the book.
TYPE:
|
date_read
|
Filter by an exact read date.
TYPE:
|
date_read_gt
|
Filter for items read after the given date.
TYPE:
|
date_read_gte
|
Filter for items read on or after the given date.
TYPE:
|
date_read_lt
|
Filter for items read before the given date.
TYPE:
|
date_read_lte
|
Filter for items read on or before the given date.
TYPE:
|
grade
|
Filter by the assigned grade value.
TYPE:
|
grading_company
|
Filter by the grading company that issued the grade.
TYPE:
|
is_read
|
Filter by read status.
TYPE:
|
modified_gt
|
Return collections modified after this datetime.
TYPE:
|
purchase_date
|
Filter by an exact purchase date.
TYPE:
|
purchase_date_gt
|
Filter for items purchased after the given date.
TYPE:
|
purchase_date_gte
|
Filter for items purchased on or after the given date.
TYPE:
|
purchase_date_lt
|
Filter for items purchased before the given date.
TYPE:
|
purchase_date_lte
|
Filter for items purchased on or before the given date.
TYPE:
|
purchase_store
|
Filter by the name of the purchase store.
TYPE:
|
rating
|
Filter by the assigned rating value.
TYPE:
|
series_id
|
Filter by series id.
TYPE:
|
storage_location
|
Filter by the storage location of the item.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BaseCollection]
|
A list of BaseCollection objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_creators
Retrieve a list of creators with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return creators modified after this datetime.
TYPE:
|
name
|
Filter creators by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing creators. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_imprints
Retrieve a list of imprints with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return imprints modified after this datetime.
TYPE:
|
name
|
Filter imprints by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing imprints. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_issues
Retrieve a list of issues with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
alt_number
|
Filter by the issue's alternate number.
TYPE:
|
character_id
|
Filter by the creator ID.
TYPE:
|
cover_hash
|
Filter by the hash value of the issue's cover image.
TYPE:
|
cover_month
|
Filter by the cover month (1-12).
TYPE:
|
cover_year
|
Filter by the cover year.
TYPE:
|
creator_id
|
Filter by the creator ID.
TYPE:
|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
foc_date
|
Filter by an exact Final Order Cutoff (FOC) date.
TYPE:
|
foc_date_range_after
|
Filter for issues with an FOC date after the given date.
TYPE:
|
foc_date_range_before
|
Filter for issues with an FOC date before the given date.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
imprint_id
|
Filter by the associated imprint ID.
TYPE:
|
imprint_name
|
Filter by the associated imprint name.
TYPE:
|
missing_cv_id
|
If True, return only issues missing a Comic Vine ID.
TYPE:
|
missing_gcd_id
|
If True, return only issues missing a Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return issues modified after this datetime.
TYPE:
|
number
|
Filter by the issue number.
TYPE:
|
publisher_id
|
Filter by the publisher ID.
TYPE:
|
publisher_name
|
Filter by the publisher name.
TYPE:
|
rating
|
Filter by the issue rating.
TYPE:
|
role_ids
|
Filter by a list of role IDs.
TYPE:
|
series_id
|
Filter by the series ID.
TYPE:
|
series_name
|
Filter by the series name.
TYPE:
|
series_volume
|
Filter by the series volume number.
TYPE:
|
series_year_began
|
Filter by the year the series began.
TYPE:
|
sku
|
Filter by the distributor SKU.
TYPE:
|
store_date
|
Filter by an exact store date.
TYPE:
|
store_date_range_after
|
Filter for issues with a store date after the given date.
TYPE:
|
store_date_range_before
|
Filter for issues with a store date before the given date.
TYPE:
|
team_id
|
Filter by the team ID.
TYPE:
|
universe_id
|
Filter by the universe ID.
TYPE:
|
upc
|
Filter by the issue's UPC barcode.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonIssue]
|
A list of CommonIssue objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_publisher_series
Retrieve a list of series that are part of a specific publisher.
| PARAMETER | DESCRIPTION |
|---|---|
publisher_id
|
The unique identifier of the publisher.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonSeries]
|
A list of CommonSeries objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 | |
list_publishers
Retrieve a list of publishers with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return publishers modified after this datetime.
TYPE:
|
name
|
Filter publishers by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing publishers. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_reading_list_items
Retrieve a list of items that are part of a specific reading list.
| PARAMETER | DESCRIPTION |
|---|---|
reading_list_id
|
The unique identifier of the reading list.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[ReadingListItem]
|
A list of ReadingListItem objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 | |
list_reading_lists
Retrieve a list of reading lists with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
attribution_source
|
Filter by the source of attribution.
TYPE:
|
average_rating_gte
|
Filter for reading lists with an average rating greater than or equal to this value.
TYPE:
|
is_private
|
Filter by privacy status.
TYPE:
|
list_type
|
Filter by the type of reading list.
TYPE:
|
modified_gt
|
Return reading lists modified after this datetime.
TYPE:
|
name
|
Filter reading lists by name (partial match).
TYPE:
|
publisher_name
|
Filter by the publisher name.
TYPE:
|
user_id
|
Filter by the owner user's ID.
TYPE:
|
username
|
Filter by the owner user's username.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BaseReadingList]
|
A list of BaseReadingList objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 | |
list_roles
Retrieve a list of roles with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
modified_gt
|
Return roles modified after this datetime.
TYPE:
|
name
|
Filter roles by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[GenericResource]
|
A list of GenericResource objects representing roles. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 | |
list_series
Retrieve a list of series with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
character_id
|
Filter by the character ID.
TYPE:
|
creator_id
|
Filter by the creator ID.
TYPE:
|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
imprint_id
|
Filter by the imprint ID.
TYPE:
|
imprint_name
|
Filter by the associated imprint name.
TYPE:
|
missing_cv_id
|
If True, return only series missing a Comic Vine ID.
TYPE:
|
missing_gcd_id
|
If True, return only series missing a Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return series modified after this datetime.
TYPE:
|
name
|
Filter series by name (partial match).
TYPE:
|
publisher_id
|
Filter by the publisher ID.
TYPE:
|
publisher_name
|
Filter by the publisher name.
TYPE:
|
role_ids
|
Filter by a list of role IDs.
TYPE:
|
series_type_name
|
Filter by the series type name.
TYPE:
|
series_type_id
|
Filter by the series type ID.
TYPE:
|
status
|
Filter by the publication status.
TYPE:
|
team_id
|
Filter by the team ID.
TYPE:
|
universe_id
|
Filter by the universe ID.
TYPE:
|
volume
|
Filter by the series volume number.
TYPE:
|
year_began
|
Filter by the year the series began.
TYPE:
|
year_end
|
Filter by the year the series ended.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonSeries]
|
A list of CommonSeries objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 | |
list_series_issues
Retrieve a list of issues that are part of a specific series.
| PARAMETER | DESCRIPTION |
|---|---|
series_id
|
The unique identifier of the series.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonIssue]
|
A list of CommonIssue objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 | |
list_series_types
Retrieve a list of series types with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
modified_gt
|
Return series types modified after this datetime.
TYPE:
|
name
|
Filter series types by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[GenericResource]
|
A list of GenericResource objects representing series types. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 | |
list_team_issues
Retrieve a list of issues that are part of a specific team.
| PARAMETER | DESCRIPTION |
|---|---|
team_id
|
The unique identifier of the team.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonIssue]
|
A list of CommonIssue objects. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 | |
list_teams
Retrieve a list of teams with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
cv_id
|
Filter by Comic Vine ID.
TYPE:
|
gcd_id
|
Filter by Grand Comics Database ID.
TYPE:
|
modified_gt
|
Return teams modified after this datetime.
TYPE:
|
name
|
Filter teams by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing teams. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 | |
list_universes
Retrieve a list of universes with optional filtering.
| PARAMETER | DESCRIPTION |
|---|---|
designation
|
Filter universes by designation (partial match).
TYPE:
|
modified_gt
|
Return universes modified after this datetime.
TYPE:
|
name
|
Filter universes by name (partial match).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[CommonResource]
|
A list of CommonResource objects representing universes. |
| RAISES | DESCRIPTION |
|---|---|
ServiceError
|
If the API response is invalid or validation fails. |
AuthenticationError
|
If credentials are invalid. |
RateLimitError
|
If the API rate limit is exceeded. |
Source code in seagrin/metron.py
| Python | |
|---|---|
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 | |