Cdn Public Collector's Pricing Guide (CPG) API V2

GetCollectibleRequest

Catalog

Retrieve collectible(s)

The following routes are available for this service:
GET	/GetCollectibleRequest		Specify ApiLevel=Advanced for additional collectible information.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    total: int = 0
    op_code: int = 0
    error_text: Optional[str] = None
    request_time: Optional[str] = None
    response_time: Optional[str] = None
    total_execution_time: Optional[str] = None
    cached_response: bool = False
    permit_access: bool = False
    access_denied_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NodeDto:
    id: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    featured_image_url: Optional[str] = None
    featured_image_attribution: Optional[str] = None
    flag_code: Optional[str] = None
    country_name: Optional[str] = None
    sorting_position: int = 0
    node_children_count_live: int = 0
    collectible_children_count_live: int = 0
    parent_node__id: Optional[int] = None
    root_node__id: Optional[int] = None
    child_nodes: Optional[List[NodeDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectibleDto:
    gsid: int = 0
    ui_parent_id: Optional[int] = None
    name: Optional[str] = None
    pcgs_number: Optional[str] = None
    friedberg_number: Optional[str] = None
    coin_date: Optional[str] = None
    denomination_short: Optional[str] = None
    denomination_long: Optional[str] = None
    variety: Optional[str] = None
    variety2: Optional[str] = None
    desg: Optional[str] = None
    other: Optional[str] = None
    prefix: Optional[str] = None
    mint_mark: Optional[str] = None
    composition: Optional[str] = None
    mintage: Optional[str] = None
    strike_type: Optional[str] = None
    diameter: Optional[str] = None
    fineness: Optional[str] = None
    weight_grams: Decimal = decimal.Decimal(0)
    weight_ounces: Decimal = decimal.Decimal(0)
    designer: Optional[str] = None
    edge: Optional[str] = None
    rarity: Optional[str] = None
    coin_shape: Optional[str] = None
    description: Optional[str] = None
    general_notes: Optional[str] = None
    general_notes_source: Optional[str] = None
    general_coin_lettering: Optional[str] = None
    obverse_description: Optional[str] = None
    obverse_designer: Optional[str] = None
    obverse_lettering: Optional[str] = None
    reverse_description: Optional[str] = None
    reverse_designer: Optional[str] = None
    reverse_lettering: Optional[str] = None
    bn_b_number: Optional[str] = None
    note_color: Optional[str] = None
    note_dimension: Optional[str] = None
    pick_number: Optional[str] = None
    watermark: Optional[str] = None
    printer: Optional[str] = None
    note_security_thread: Optional[str] = None
    note_paper_type: Optional[str] = None
    bnb_signature_name1: Optional[str] = None
    bnb_signature_name2: Optional[str] = None
    bnb_signature_name3: Optional[str] = None
    obsolete_bank_id: Optional[str] = None
    obsolete_state_name: Optional[str] = None
    obsolete_city_name: Optional[str] = None
    obsolete_bank_name: Optional[str] = None
    haxby_number: Optional[str] = None
    bnb_title: Optional[str] = None
    issue_number: Optional[str] = None
    issue_month: int = 0
    issue_year: int = 0
    variant: Optional[str] = None
    art_comment1: Optional[str] = None
    art_comment2: Optional[str] = None
    art_comment3: Optional[str] = None
    key_comment1: Optional[str] = None
    key_comment2: Optional[str] = None
    key_comment3: Optional[str] = None
    ngc: Optional[str] = None
    krause: Optional[str] = None
    ebay_category1: int = 0
    featured_image_url: Optional[str] = None
    featured_image_attribution: Optional[str] = None
    is_type: bool = False
    is_set: bool = False
    price_low: Decimal = decimal.Decimal(0)
    price_high: Decimal = decimal.Decimal(0)
    is100_greatest_u_s_coins: int = 0
    is100_greatest_u_s_paper_money: int = 0
    is100_greatest_world_paper_money: int = 0
    is100_greatest_modern_us_coins: int = 0
    is_redbook: bool = False
    is_cherry_picker: bool = False
    root_node__id: int = 0
    parent_node__id: int = 0
    parent_node_name: Optional[str] = None
    sorting_position: int = 0
    catalog_path: Optional[List[NodeDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectibleResponse(BaseResponse):
    data: Optional[List[CollectibleDto]] = None


# @Api(Description="Retrieve collectible(s)")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCollectibleRequest:
    """
    Retrieve collectible(s)
    """

    gs_id: int = 0
    api_level: Optional[str] = None

Python GetCollectibleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /GetCollectibleRequest HTTP/1.1 
Host: cpgpublicapiv2dev.greysheet.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CollectibleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.PublicApiV2.ResponseObjects">
  <AccessDeniedMessage>String</AccessDeniedMessage>
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <PermitAccess>false</PermitAccess>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.PublicApiV2.Dto">
    <d2p1:CollectibleDto>
      <d2p1:ArtComment1>String</d2p1:ArtComment1>
      <d2p1:ArtComment2>String</d2p1:ArtComment2>
      <d2p1:ArtComment3>String</d2p1:ArtComment3>
      <d2p1:BnBNumber>String</d2p1:BnBNumber>
      <d2p1:BnbSignatureName1>String</d2p1:BnbSignatureName1>
      <d2p1:BnbSignatureName2>String</d2p1:BnbSignatureName2>
      <d2p1:BnbSignatureName3>String</d2p1:BnbSignatureName3>
      <d2p1:BnbTitle>String</d2p1:BnbTitle>
      <d2p1:CatalogPath>
        <d2p1:NodeDto>
          <d2p1:ChildNodes>
            <d2p1:NodeDto>
              <d2p1:ChildNodes>
                <d2p1:NodeDto>
                  <d2p1:ChildNodes i:nil="true" />
                  <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
                  <d2p1:CountryName>String</d2p1:CountryName>
                  <d2p1:Description>String</d2p1:Description>
                  <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
                  <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
                  <d2p1:FlagCode>String</d2p1:FlagCode>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
                  <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
                  <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
                  <d2p1:SortingPosition>0</d2p1:SortingPosition>
                </d2p1:NodeDto>
              </d2p1:ChildNodes>
              <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
              <d2p1:CountryName>String</d2p1:CountryName>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
              <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
              <d2p1:FlagCode>String</d2p1:FlagCode>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
              <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
              <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
              <d2p1:SortingPosition>0</d2p1:SortingPosition>
            </d2p1:NodeDto>
          </d2p1:ChildNodes>
          <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
          <d2p1:CountryName>String</d2p1:CountryName>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
          <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
          <d2p1:FlagCode>String</d2p1:FlagCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
          <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
          <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
          <d2p1:SortingPosition>0</d2p1:SortingPosition>
        </d2p1:NodeDto>
      </d2p1:CatalogPath>
      <d2p1:CoinDate>String</d2p1:CoinDate>
      <d2p1:CoinShape>String</d2p1:CoinShape>
      <d2p1:Composition>String</d2p1:Composition>
      <d2p1:DenominationLong>String</d2p1:DenominationLong>
      <d2p1:DenominationShort>String</d2p1:DenominationShort>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Desg>String</d2p1:Desg>
      <d2p1:Designer>String</d2p1:Designer>
      <d2p1:Diameter>String</d2p1:Diameter>
      <d2p1:EbayCategory1>0</d2p1:EbayCategory1>
      <d2p1:Edge>String</d2p1:Edge>
      <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
      <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
      <d2p1:Fineness>String</d2p1:Fineness>
      <d2p1:FriedbergNumber>String</d2p1:FriedbergNumber>
      <d2p1:GeneralCoinLettering>String</d2p1:GeneralCoinLettering>
      <d2p1:GeneralNotes>String</d2p1:GeneralNotes>
      <d2p1:GeneralNotesSource>String</d2p1:GeneralNotesSource>
      <d2p1:Gsid>0</d2p1:Gsid>
      <d2p1:HaxbyNumber>String</d2p1:HaxbyNumber>
      <d2p1:Is100GreatestModernUsCoins>0</d2p1:Is100GreatestModernUsCoins>
      <d2p1:Is100GreatestUSCoins>0</d2p1:Is100GreatestUSCoins>
      <d2p1:Is100GreatestUSPaperMoney>0</d2p1:Is100GreatestUSPaperMoney>
      <d2p1:Is100GreatestWorldPaperMoney>0</d2p1:Is100GreatestWorldPaperMoney>
      <d2p1:IsCherryPicker>false</d2p1:IsCherryPicker>
      <d2p1:IsRedbook>false</d2p1:IsRedbook>
      <d2p1:IsSet>false</d2p1:IsSet>
      <d2p1:IsType>false</d2p1:IsType>
      <d2p1:IssueMonth>0</d2p1:IssueMonth>
      <d2p1:IssueNumber>String</d2p1:IssueNumber>
      <d2p1:IssueYear>0</d2p1:IssueYear>
      <d2p1:KeyComment1>String</d2p1:KeyComment1>
      <d2p1:KeyComment2>String</d2p1:KeyComment2>
      <d2p1:KeyComment3>String</d2p1:KeyComment3>
      <d2p1:Krause>String</d2p1:Krause>
      <d2p1:MintMark>String</d2p1:MintMark>
      <d2p1:Mintage>String</d2p1:Mintage>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Ngc>String</d2p1:Ngc>
      <d2p1:NoteColor>String</d2p1:NoteColor>
      <d2p1:NoteDimension>String</d2p1:NoteDimension>
      <d2p1:NotePaperType>String</d2p1:NotePaperType>
      <d2p1:NoteSecurityThread>String</d2p1:NoteSecurityThread>
      <d2p1:ObsoleteBankId>String</d2p1:ObsoleteBankId>
      <d2p1:ObsoleteBankName>String</d2p1:ObsoleteBankName>
      <d2p1:ObsoleteCityName>String</d2p1:ObsoleteCityName>
      <d2p1:ObsoleteStateName>String</d2p1:ObsoleteStateName>
      <d2p1:ObverseDescription>String</d2p1:ObverseDescription>
      <d2p1:ObverseDesigner>String</d2p1:ObverseDesigner>
      <d2p1:ObverseLettering>String</d2p1:ObverseLettering>
      <d2p1:Other>String</d2p1:Other>
      <d2p1:ParentNodeName>String</d2p1:ParentNodeName>
      <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
      <d2p1:PcgsNumber>String</d2p1:PcgsNumber>
      <d2p1:PickNumber>String</d2p1:PickNumber>
      <d2p1:Prefix>String</d2p1:Prefix>
      <d2p1:PriceHigh>0</d2p1:PriceHigh>
      <d2p1:PriceLow>0</d2p1:PriceLow>
      <d2p1:Printer>String</d2p1:Printer>
      <d2p1:Rarity>String</d2p1:Rarity>
      <d2p1:ReverseDescription>String</d2p1:ReverseDescription>
      <d2p1:ReverseDesigner>String</d2p1:ReverseDesigner>
      <d2p1:ReverseLettering>String</d2p1:ReverseLettering>
      <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
      <d2p1:SortingPosition>0</d2p1:SortingPosition>
      <d2p1:StrikeType>String</d2p1:StrikeType>
      <d2p1:UiParentId>0</d2p1:UiParentId>
      <d2p1:Variant>String</d2p1:Variant>
      <d2p1:Variety>String</d2p1:Variety>
      <d2p1:Variety2>String</d2p1:Variety2>
      <d2p1:Watermark>String</d2p1:Watermark>
      <d2p1:WeightGrams>0</d2p1:WeightGrams>
      <d2p1:WeightOunces>0</d2p1:WeightOunces>
    </d2p1:CollectibleDto>
  </Data>
</CollectibleResponse>