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.

export class BaseResponse
{
    public Total: number;
    public OpCode: number;
    public ErrorText: string;
    public RequestTime: string;
    public ResponseTime: string;
    public TotalExecutionTime: string;
    public CachedResponse: boolean;
    public PermitAccess: boolean;
    public AccessDeniedMessage: string;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class NodeDto
{
    public Id: number;
    public Name: string;
    public Description: string;
    public FeaturedImageUrl: string;
    public FeaturedImageAttribution: string;
    public FlagCode: string;
    public CountryName: string;
    public SortingPosition: number;
    public NodeChildrenCountLive: number;
    public CollectibleChildrenCountLive: number;
    public ParentNode_Id?: number;
    public RootNode_Id?: number;
    public ChildNodes: NodeDto[];

    public constructor(init?: Partial<NodeDto>) { (Object as any).assign(this, init); }
}

export class CollectibleDto
{
    public Gsid: number;
    public UiParentId?: number;
    public Name: string;
    public PcgsNumber: string;
    public FriedbergNumber: string;
    public CoinDate: string;
    public DenominationShort: string;
    public DenominationLong: string;
    public Variety: string;
    public Variety2: string;
    public Desg: string;
    public Other: string;
    public Prefix: string;
    public MintMark: string;
    public Composition: string;
    public Mintage: string;
    public StrikeType: string;
    public Diameter: string;
    public Fineness: string;
    public WeightGrams: number;
    public WeightOunces: number;
    public Designer: string;
    public Edge: string;
    public Rarity: string;
    public CoinShape: string;
    public Description: string;
    public GeneralNotes: string;
    public GeneralNotesSource: string;
    public GeneralCoinLettering: string;
    public ObverseDescription: string;
    public ObverseDesigner: string;
    public ObverseLettering: string;
    public ReverseDescription: string;
    public ReverseDesigner: string;
    public ReverseLettering: string;
    public BnBNumber: string;
    public NoteColor: string;
    public NoteDimension: string;
    public PickNumber: string;
    public Watermark: string;
    public Printer: string;
    public NoteSecurityThread: string;
    public NotePaperType: string;
    public BnbSignatureName1: string;
    public BnbSignatureName2: string;
    public BnbSignatureName3: string;
    public ObsoleteBankId: string;
    public ObsoleteStateName: string;
    public ObsoleteCityName: string;
    public ObsoleteBankName: string;
    public HaxbyNumber: string;
    public BnbTitle: string;
    public IssueNumber: string;
    public IssueMonth: number;
    public IssueYear: number;
    public Variant: string;
    public ArtComment1: string;
    public ArtComment2: string;
    public ArtComment3: string;
    public KeyComment1: string;
    public KeyComment2: string;
    public KeyComment3: string;
    public Ngc: string;
    public Krause: string;
    public EbayCategory1: number;
    public FeaturedImageUrl: string;
    public FeaturedImageAttribution: string;
    public IsType: boolean;
    public IsSet: boolean;
    public PriceLow: number;
    public PriceHigh: number;
    public Is100GreatestUSCoins: number;
    public Is100GreatestUSPaperMoney: number;
    public Is100GreatestWorldPaperMoney: number;
    public Is100GreatestModernUsCoins: number;
    public IsRedbook: boolean;
    public IsCherryPicker: boolean;
    public RootNode_Id: number;
    public ParentNode_Id: number;
    public ParentNodeName: string;
    public SortingPosition: number;
    public CatalogPath: NodeDto[];

    public constructor(init?: Partial<CollectibleDto>) { (Object as any).assign(this, init); }
}

export class CollectibleResponse extends BaseResponse
{
    public Data: CollectibleDto[];

    public constructor(init?: Partial<CollectibleResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description Retrieve collectible(s) */
// @Api(Description="Retrieve collectible(s)")
export class GetCollectibleRequest
{
    public GsId: number;
    public ApiLevel: string;

    public constructor(init?: Partial<GetCollectibleRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetCollectibleRequest DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Data":[{"Gsid":0,"UiParentId":0,"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":0,"WeightOunces":0,"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":0,"IssueYear":0,"Variant":"String","ArtComment1":"String","ArtComment2":"String","ArtComment3":"String","KeyComment1":"String","KeyComment2":"String","KeyComment3":"String","Ngc":"String","Krause":"String","EbayCategory1":0,"FeaturedImageUrl":"String","FeaturedImageAttribution":"String","IsType":false,"IsSet":false,"PriceLow":0,"PriceHigh":0,"Is100GreatestUSCoins":0,"Is100GreatestUSPaperMoney":0,"Is100GreatestWorldPaperMoney":0,"Is100GreatestModernUsCoins":0,"IsRedbook":false,"IsCherryPicker":false,"RootNode_Id":0,"ParentNode_Id":0,"ParentNodeName":"String","SortingPosition":0,"CatalogPath":[{"Id":0,"Name":"String","Description":"String","FeaturedImageUrl":"String","FeaturedImageAttribution":"String","FlagCode":"String","CountryName":"String","SortingPosition":0,"NodeChildrenCountLive":0,"CollectibleChildrenCountLive":0,"ParentNode_Id":0,"RootNode_Id":0,"ChildNodes":[{"Id":0,"Name":"String","Description":"String","FeaturedImageUrl":"String","FeaturedImageAttribution":"String","FlagCode":"String","CountryName":"String","SortingPosition":0,"NodeChildrenCountLive":0,"CollectibleChildrenCountLive":0,"ParentNode_Id":0,"RootNode_Id":0,"ChildNodes":[{"Id":0,"Name":"String","Description":"String","FeaturedImageUrl":"String","FeaturedImageAttribution":"String","FlagCode":"String","CountryName":"String","SortingPosition":0,"NodeChildrenCountLive":0,"CollectibleChildrenCountLive":0,"ParentNode_Id":0,"RootNode_Id":0}]}]}]}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false,"PermitAccess":false,"AccessDeniedMessage":"String"}