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

<back to all web services

GetCollectibleRequest

Catalog

Retrieve collectible(s)

The following routes are available for this service:
GET/GetCollectibleRequestSpecify ApiLevel=Advanced for additional collectible information.
"use strict";
export class BaseResponse {
    /** @param {{Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Total;
    /** @type {number} */
    OpCode;
    /** @type {string} */
    ErrorText;
    /** @type {string} */
    RequestTime;
    /** @type {string} */
    ResponseTime;
    /** @type {string} */
    TotalExecutionTime;
    /** @type {boolean} */
    CachedResponse;
    /** @type {boolean} */
    PermitAccess;
    /** @type {string} */
    AccessDeniedMessage;
}
export class NodeDto {
    /** @param {{Id?:number,Name?:string,Description?:string,FeaturedImageUrl?:string,FeaturedImageAttribution?:string,FlagCode?:string,CountryName?:string,SortingPosition?:number,NodeChildrenCountLive?:number,CollectibleChildrenCountLive?:number,ParentNode_Id?:number,RootNode_Id?:number,ChildNodes?:NodeDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    FeaturedImageUrl;
    /** @type {string} */
    FeaturedImageAttribution;
    /** @type {string} */
    FlagCode;
    /** @type {string} */
    CountryName;
    /** @type {number} */
    SortingPosition;
    /** @type {number} */
    NodeChildrenCountLive;
    /** @type {number} */
    CollectibleChildrenCountLive;
    /** @type {?number} */
    ParentNode_Id;
    /** @type {?number} */
    RootNode_Id;
    /** @type {NodeDto[]} */
    ChildNodes;
}
export class CollectibleDto {
    /** @param {{Gsid?:number,UiParentId?:number,Name?:string,PcgsNumber?:string,FriedbergNumber?:string,CoinDate?:string,DenominationShort?:string,DenominationLong?:string,Variety?:string,Variety2?:string,Desg?:string,Other?:string,Prefix?:string,MintMark?:string,Composition?:string,Mintage?:string,StrikeType?:string,Diameter?:string,Fineness?:string,WeightGrams?:number,WeightOunces?:number,Designer?:string,Edge?:string,Rarity?:string,CoinShape?:string,Description?:string,GeneralNotes?:string,GeneralNotesSource?:string,GeneralCoinLettering?:string,ObverseDescription?:string,ObverseDesigner?:string,ObverseLettering?:string,ReverseDescription?:string,ReverseDesigner?:string,ReverseLettering?:string,BnBNumber?:string,NoteColor?:string,NoteDimension?:string,PickNumber?:string,Watermark?:string,Printer?:string,NoteSecurityThread?:string,NotePaperType?:string,BnbSignatureName1?:string,BnbSignatureName2?:string,BnbSignatureName3?:string,ObsoleteBankId?:string,ObsoleteStateName?:string,ObsoleteCityName?:string,ObsoleteBankName?:string,HaxbyNumber?:string,BnbTitle?:string,IssueNumber?:string,IssueMonth?:number,IssueYear?:number,Variant?:string,ArtComment1?:string,ArtComment2?:string,ArtComment3?:string,KeyComment1?:string,KeyComment2?:string,KeyComment3?:string,Ngc?:string,Krause?:string,EbayCategory1?:number,FeaturedImageUrl?:string,FeaturedImageAttribution?:string,IsType?:boolean,IsSet?:boolean,PriceLow?:number,PriceHigh?:number,Is100GreatestUSCoins?:number,Is100GreatestUSPaperMoney?:number,Is100GreatestWorldPaperMoney?:number,Is100GreatestModernUsCoins?:number,IsRedbook?:boolean,IsCherryPicker?:boolean,RootNode_Id?:number,ParentNode_Id?:number,ParentNodeName?:string,SortingPosition?:number,CatalogPath?:NodeDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Gsid;
    /** @type {?number} */
    UiParentId;
    /** @type {string} */
    Name;
    /** @type {string} */
    PcgsNumber;
    /** @type {string} */
    FriedbergNumber;
    /** @type {string} */
    CoinDate;
    /** @type {string} */
    DenominationShort;
    /** @type {string} */
    DenominationLong;
    /** @type {string} */
    Variety;
    /** @type {string} */
    Variety2;
    /** @type {string} */
    Desg;
    /** @type {string} */
    Other;
    /** @type {string} */
    Prefix;
    /** @type {string} */
    MintMark;
    /** @type {string} */
    Composition;
    /** @type {string} */
    Mintage;
    /** @type {string} */
    StrikeType;
    /** @type {string} */
    Diameter;
    /** @type {string} */
    Fineness;
    /** @type {number} */
    WeightGrams;
    /** @type {number} */
    WeightOunces;
    /** @type {string} */
    Designer;
    /** @type {string} */
    Edge;
    /** @type {string} */
    Rarity;
    /** @type {string} */
    CoinShape;
    /** @type {string} */
    Description;
    /** @type {string} */
    GeneralNotes;
    /** @type {string} */
    GeneralNotesSource;
    /** @type {string} */
    GeneralCoinLettering;
    /** @type {string} */
    ObverseDescription;
    /** @type {string} */
    ObverseDesigner;
    /** @type {string} */
    ObverseLettering;
    /** @type {string} */
    ReverseDescription;
    /** @type {string} */
    ReverseDesigner;
    /** @type {string} */
    ReverseLettering;
    /** @type {string} */
    BnBNumber;
    /** @type {string} */
    NoteColor;
    /** @type {string} */
    NoteDimension;
    /** @type {string} */
    PickNumber;
    /** @type {string} */
    Watermark;
    /** @type {string} */
    Printer;
    /** @type {string} */
    NoteSecurityThread;
    /** @type {string} */
    NotePaperType;
    /** @type {string} */
    BnbSignatureName1;
    /** @type {string} */
    BnbSignatureName2;
    /** @type {string} */
    BnbSignatureName3;
    /** @type {string} */
    ObsoleteBankId;
    /** @type {string} */
    ObsoleteStateName;
    /** @type {string} */
    ObsoleteCityName;
    /** @type {string} */
    ObsoleteBankName;
    /** @type {string} */
    HaxbyNumber;
    /** @type {string} */
    BnbTitle;
    /** @type {string} */
    IssueNumber;
    /** @type {number} */
    IssueMonth;
    /** @type {number} */
    IssueYear;
    /** @type {string} */
    Variant;
    /** @type {string} */
    ArtComment1;
    /** @type {string} */
    ArtComment2;
    /** @type {string} */
    ArtComment3;
    /** @type {string} */
    KeyComment1;
    /** @type {string} */
    KeyComment2;
    /** @type {string} */
    KeyComment3;
    /** @type {string} */
    Ngc;
    /** @type {string} */
    Krause;
    /** @type {number} */
    EbayCategory1;
    /** @type {string} */
    FeaturedImageUrl;
    /** @type {string} */
    FeaturedImageAttribution;
    /** @type {boolean} */
    IsType;
    /** @type {boolean} */
    IsSet;
    /** @type {number} */
    PriceLow;
    /** @type {number} */
    PriceHigh;
    /** @type {number} */
    Is100GreatestUSCoins;
    /** @type {number} */
    Is100GreatestUSPaperMoney;
    /** @type {number} */
    Is100GreatestWorldPaperMoney;
    /** @type {number} */
    Is100GreatestModernUsCoins;
    /** @type {boolean} */
    IsRedbook;
    /** @type {boolean} */
    IsCherryPicker;
    /** @type {number} */
    RootNode_Id;
    /** @type {number} */
    ParentNode_Id;
    /** @type {string} */
    ParentNodeName;
    /** @type {number} */
    SortingPosition;
    /** @type {NodeDto[]} */
    CatalogPath;
}
export class CollectibleResponse extends BaseResponse {
    /** @param {{Data?:CollectibleDto[],Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {CollectibleDto[]} */
    Data;
}
export class GetCollectibleRequest {
    /** @param {{GsId?:number,ApiLevel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    GsId;
    /** @type {string} */
    ApiLevel;
}

JavaScript 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: publicapiv2dev.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>