Comicvine
ComicvineResource
Bases: Enum
Enum class for Comicvine Resources.
| ATTRIBUTE | DESCRIPTION |
|---|---|
ISSUE |
|
CHARACTER |
|
PUBLISHER |
|
CONCEPT |
|
LOCATION |
|
ORIGIN |
|
POWER |
|
CREATOR |
|
STORY_ARC |
|
VOLUME |
|
ITEM |
|
TEAM |
|
Attributes
resource_id
property
Start of id used by Comicvine to create unique ids.
search_resource
property
Resource string for filtering searches.
search_response
property
Response type for resource when using a search endpoint.
Comicvine
Class with functionality to request Comicvine API endpoints.
| PARAMETER | DESCRIPTION |
|---|---|
api_key
|
User's API key to access the Comicvine API.
TYPE:
|
cache
|
Cache object to store and retrieve responses.
TYPE:
|
base_url
|
Root URL of the Comicvine API.
TYPE:
|
user_agent
|
Value sent in the
TYPE:
|
timeout
|
Number of seconds to wait for a server response before timing out.
TYPE:
|
limiter
|
Set a custom limiter, used for testing.
TYPE:
|
Source code in simyan/comicvine.py
| Python | |
|---|---|
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | |
Functions
get_character
Request a Character using its id.
| PARAMETER | DESCRIPTION |
|---|---|
character_id
|
The Character id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Character
|
A Character object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 | |
get_concept
Request a Concept using its id.
| PARAMETER | DESCRIPTION |
|---|---|
concept_id
|
The Concept id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Concept
|
A Concept object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 | |
get_creator
Request a Creator using its id.
| PARAMETER | DESCRIPTION |
|---|---|
creator_id
|
The Creator id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Creator
|
A Creator object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | |
get_issue
Request an Issue using its id.
| PARAMETER | DESCRIPTION |
|---|---|
issue_id
|
The Issue id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Issue
|
A Issue object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | |
get_item
Request an Item using its id.
| PARAMETER | DESCRIPTION |
|---|---|
item_id
|
The Item id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Item
|
An Item object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 | |
get_location
Request a Location using its id.
| PARAMETER | DESCRIPTION |
|---|---|
location_id
|
The Location id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Location
|
A Location object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | |
get_origin
Request an Origin using its id.
| PARAMETER | DESCRIPTION |
|---|---|
origin_id
|
The Origin id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Origin
|
An Origin object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 | |
get_power
Request a Power using its id.
| PARAMETER | DESCRIPTION |
|---|---|
power_id
|
The Power id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Power
|
A Power object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | |
get_publisher
Request a Publisher using its id.
| PARAMETER | DESCRIPTION |
|---|---|
publisher_id
|
The Publisher id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Publisher
|
A Publisher object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
get_story_arc
Request a Story Arc using its id.
| PARAMETER | DESCRIPTION |
|---|---|
story_arc_id
|
The StoryArc id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
StoryArc
|
A StoryArc object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | |
get_team
Request a Team using its id.
| PARAMETER | DESCRIPTION |
|---|---|
team_id
|
The Team id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Team
|
A Team object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 | |
get_volume
Request a Volume using its id.
| PARAMETER | DESCRIPTION |
|---|---|
volume_id
|
The Volume id.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Volume
|
A Volume object or None if not found. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | |
list_characters
Request a list of Characters.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicCharacter]
|
A list of Character 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 simyan/comicvine.py
| Python | |
|---|---|
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 | |
list_concepts
Request a list of Concepts.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicConcept]
|
A list of Concept 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 simyan/comicvine.py
| Python | |
|---|---|
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 | |
list_creators
Request a list of Creators.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicCreator]
|
A list of Creator 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 simyan/comicvine.py
| Python | |
|---|---|
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | |
list_issues
Request a list of Issues.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicIssue]
|
A list of Issue 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 simyan/comicvine.py
| Python | |
|---|---|
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | |
list_items
Request a list of Items.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicItem]
|
A list of Item 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 simyan/comicvine.py
| Python | |
|---|---|
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 | |
list_locations
Request a list of Locations.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicLocation]
|
A list of Location 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 simyan/comicvine.py
| Python | |
|---|---|
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 | |
list_origins
Request a list of Origins.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicOrigin]
|
A list of Origin 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 simyan/comicvine.py
| Python | |
|---|---|
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 | |
list_powers
Request a list of Powers.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicPower]
|
A list of Power 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 simyan/comicvine.py
| Python | |
|---|---|
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 | |
list_publishers
Request a list of Publishers.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicPublisher]
|
A list of Publisher 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 simyan/comicvine.py
| Python | |
|---|---|
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | |
list_story_arcs
Request a list of Story Arcs.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicStoryArc]
|
A list of StoryArc 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 simyan/comicvine.py
| Python | |
|---|---|
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | |
list_teams
Request a list of Teams.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicTeam]
|
A list of Team 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 simyan/comicvine.py
| Python | |
|---|---|
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 | |
list_volumes
Request a list of Volumes.
| PARAMETER | DESCRIPTION |
|---|---|
params
|
Parameters to add to the request.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicVolume]
|
A list of Volume 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 simyan/comicvine.py
| Python | |
|---|---|
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | |
search
Request a list of search results filtered by provided resource.
| PARAMETER | DESCRIPTION |
|---|---|
resource
|
Filter which type of resource to return.
TYPE:
|
query
|
Search query string.
TYPE:
|
max_results
|
Limits the amount of results looked up and returned.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[BasicPublisher] | list[BasicVolume] | list[BasicIssue] | list[BasicStoryArc] | list[BasicCreator] | list[BasicCharacter] | list[BasicTeam] | list[BasicLocation] | list[BasicConcept] | list[BasicPower] | list[BasicOrigin] | list[BasicItem]
|
A list of results, mapped to the given resource. |
| 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 simyan/comicvine.py
| Python | |
|---|---|
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 | |