Common Types

There are a number of common types and formats used by the Fyendal’s Collection API that are documented here.

Money

The Money structure is commonly used to represent both the magnitude and the currency of a value. Most endpoints use this structure to represent financial datapoints.

Money.ts

interface Money {
  readonly value: number;
  readonly currency: Currency;
}

Currency

The Currency enum is the set of supported currencies as uppercase string values.

Currency.ts

enum Currency {
  AUD = "AUD",
  CAD = "CAD",
  EUR = "EUR",
  GBP = "GBP",
  IDR = "IDR",
  NZD = "NZD",
  SGD = "SGD",
  USD = "USD",
  JPY = "JPY"
}

Price Sources

The PriceSource enum is the set of supported price sources.

enum PriceSource {
  TcgPlayerMarket = "TcgPlayerMarket",
  TcgPlayerLow = "TcgPlayerLow",
  TcgPlayerRecent = "TcgPlayerRecent"
}