Numi
Numi · GPT-Aktionen
PCGS Public API
GET /banknotedetail/GetBanknoteByCertNoRetrieve information of a banknote by its certificate number.This endpoint retrieves detailed information about a banknote using its PCGS certificate number.
GET /banknotedetail/GetBanknoteImagesByCertNoRetrieve images for a banknote using its certification number.This endpoint provides images for a banknote based on its PCGS certification number.
GET /coindetail/GetCoinFactsByCertNo/{certNo}Get CoinFacts data for a coin using its cert number.Access detailed CoinFacts for a specific coin using its certification number (certNo).
GET /coindetail/GetCoinFactsByBarcodeGet CoinFacts data for a coin using its holder's barcode.This endpoint delivers detailed CoinFacts information for a coin, based on its holder's barcode.
GET /coindetail/GetAPRByCertNo/{CertNo}Get Auction Prices Realized data for a coin using its cert number.Fetch Auction Prices Realized (APR) data for a coin based on its PCGS certification number (CertNo).
GET /coindetail/GetAPRByBarcodeGet Auction Prices Realized data for a coin using its holder's barcode.Retrieve Auction Prices Realized (APR) data for a coin based on its holder's barcode.
GET /coindetail/GetImagesByCertNoGet all PCGS images available for the certification number.This endpoint offers a collection of images for a specific coin, identified by its PCGS certification number (certNo).
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "PCGS Public API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.pcgs.com/publicapi/"
}
],
"security": [
{
"BearerAuth": []
}
],
"paths": {
"/banknotedetail/GetBanknoteByCertNo": {
"get": {
"operationId": "getBanknoteByCertNo",
"summary": "Retrieve information of a banknote by its certificate number.",
"description": "This endpoint retrieves detailed information about a banknote using its PCGS certificate number. \n",
"parameters": [
{
"name": "certNo",
"in": "query",
"required": true,
"description": "The PCGS certificate number of the banknote.",
"schema": {
"type": "string"
}
},
{
"name": "languageCode",
"in": "query",
"description": "Optional language code for response localization.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response with detailed banknote information.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Banknote": {
"$ref": "#/components/schemas/Banknote"
},
"IsValidRequest": {
"type": "boolean"
},
"ServerMessage": {
"type": "string"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/banknotedetail/GetBanknoteImagesByCertNo": {
"get": {
"operationId": "getBanknoteImagesByCertNo",
"summary": "Retrieve images for a banknote using its certification number.",
"description": "This endpoint provides images for a banknote based on its PCGS certification number. \n",
"parameters": [
{
"name": "certNo",
"in": "query",
"required": true,
"description": "The PCGS certificate number to fetch images for.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response with images for the specified banknote certification number.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"CertNo": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageDetail"
}
},
"HasObverseImage": {
"type": "boolean"
},
"HasReverseImage": {
"type": "boolean"
},
"HasTrueViewImage": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
},
"IsValidRequest": {
"type": "boolean"
},
"ServerMessage": {
"type": "string"
}
}
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/coindetail/GetCoinFactsByCertNo/{certNo}": {
"get": {
"operationId": "getCoinFactsByCertNo",
"summary": "Get CoinFacts data for a coin using its cert number.",
"description": "Access detailed CoinFacts for a specific coin using its certification number (certNo).\n",
"parameters": [
{
"name": "certNo",
"in": "path",
"required": true,
"description": "The PCGS cert number of the coin.",
"schema": {
"type": "string"
}
},
{
"name": "retrieveAllData",
"in": "query",
"description": "Set to true will return all CoinFacts data including Images, APR, Pop, & Prices. Set to false if you want to exclude getting APR, Pop, Images, & Prices.",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Successful response with detailed CoinFacts data for the specified cert number.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoinFactsModel"
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/coindetail/GetCoinFactsByBarcode": {
"get": {
"operationId": "getCoinFactsByBarcode",
"summary": "Get CoinFacts data for a coin using its holder's barcode.",
"description": "This endpoint delivers detailed CoinFacts information for a coin, based on its holder's barcode.\n",
"parameters": [
{
"name": "barcode",
"in": "query",
"required": true,
"description": "The barcode text captured from either a PCGS/NGC holder.",
"schema": {
"type": "string"
}
},
{
"name": "gradingService",
"in": "query",
"required": true,
"description": "The grading service. Possible values are PCGS and NGC.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response with detailed CoinFacts data for the specified barcode.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoinFactsModel"
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/coindetail/GetAPRByCertNo/{CertNo}": {
"get": {
"operationId": "getAPRByCertNo",
"summary": "Get Auction Prices Realized data for a coin using its cert number.",
"description": "Fetch Auction Prices Realized (APR) data for a coin based on its PCGS certification number (CertNo).\n",
"parameters": [
{
"name": "CertNo",
"in": "path",
"required": true,
"description": "The PCGS cert number of the coin.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response with Auction Prices Realized data for the specified cert number.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"PCGSNo": {
"type": "string"
},
"CertNo": {
"type": "string"
},
"Name": {
"type": "string"
},
"Grade": {
"type": "string"
},
"Year": {
"type": "string"
},
"Denomination": {
"type": "string"
},
"Auctions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuctionItem"
}
},
"IsValidRequest": {
"type": "boolean"
},
"ServerMessage": {
"type": "string"
}
}
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/coindetail/GetAPRByBarcode": {
"get": {
"operationId": "getAPRByBarcode",
"summary": "Get Auction Prices Realized data for a coin using its holder's barcode.",
"description": "Retrieve Auction Prices Realized (APR) data for a coin based on its holder's barcode.\n",
"parameters": [
{
"name": "barcode",
"in": "query",
"required": true,
"description": "The barcode text captured from either a PCGS/NGC holder.",
"schema": {
"type": "string"
}
},
{
"name": "gradingService",
"in": "query",
"required": true,
"description": "The grading service, possible values are PCGS and NGC.",
"schema": {
"type": "string"
}
},
{
"name": "StartDate",
"in": "query",
"description": "The starting date of auction items to retrieve in mm-dd-yyyy format.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "EndDate",
"in": "query",
"description": "The ending date of auction items to retrieve in mm-dd-yyyy format.",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Successful response with Auction Prices Realized data for a coin based on its holder's barcode.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"PCGSNo": {
"type": "string"
},
"CertNo": {
"type": "string"
},
"Name": {
"type": "string"
},
"Year": {
"type": "integer"
},
"Denomination": {
"type": "string"
},
"Mintage": {
"type": "string"
},
"MintMark": {
"type": "string"
},
"MintLocation": {
"type": "string"
},
"MetalContent": {
"type": "string"
},
"Diameter": {
"type": "integer"
},
"Edge": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"Country": {
"type": "string"
},
"Grade": {
"type": "string"
},
"Designation": {
"type": "string"
},
"PriceGuideValue": {
"type": "integer"
},
"Population": {
"type": "integer"
},
"PopHigher": {
"type": "integer"
},
"CoinFactsLink": {
"type": "string"
},
"Designer": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoinFactsImage"
}
},
"CoinFactsNotes": {
"type": "string"
},
"MajorVariety": {
"type": "string"
},
"MinorVariety": {
"type": "string"
},
"DieVariety": {
"type": "string"
},
"AuctionList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuctionItem"
}
},
"SeriesName": {
"type": "string"
},
"Category": {
"type": "string"
},
"HasTrueViewImage": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
},
"IsNFCSecure": {
"type": "boolean"
},
"IsValidRequest": {
"type": "boolean"
},
"ServerMessage": {
"type": "string"
}
}
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/coindetail/GetImagesByCertNo": {
"get": {
"operationId": "getImagesByCertNo",
"summary": "Get all PCGS images available for the certification number.",
"description": "This endpoint offers a collection of images for a specific coin, identified by its PCGS certification number (certNo).\n",
"parameters": [
{
"name": "certNo",
"in": "query",
"required": true,
"description": "The PCGS certificate number for which to fetch images.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response with all available PCGS images for the specified certification number.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"CertNo": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageDetail"
}
},
"HasObverseImage": {
"type": "boolean"
},
"HasReverseImage": {
"type": "boolean"
},
"HasTrueViewImage": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
},
"IsValidRequest": {
"type": "boolean"
},
"ServerMessage": {
"type": "string"
}
}
}
}
}
},
"204": {
"$ref": "#/components/responses/NotFound"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
}
},
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"Banknote": {
"type": "object",
"properties": {
"PCGSNo": {
"type": "string"
},
"CertNo": {
"type": "string"
},
"Year": {
"type": "string"
},
"Denomination": {
"type": "string"
},
"Region": {
"type": "string"
},
"Grade": {
"type": "string"
},
"Details": {
"type": "string"
},
"Population": {
"type": "integer"
},
"PopHigher": {
"type": "integer"
},
"SerialNo": {
"type": "string"
},
"Height": {
"type": "string"
},
"Width": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CertImage"
}
},
"CatalogNo1": {
"type": "string"
},
"CatalogNo2": {
"type": "string"
},
"Catalog1LongDesc": {
"type": "string"
},
"Catalog2LongDesc": {
"type": "string"
},
"Catalog1ShortDesc": {
"type": "string"
},
"Catalog2ShortDesc": {
"type": "string"
},
"Signers": {
"type": "string"
},
"Qualifiers": {
"type": "string"
},
"PlateNo": {
"type": "string"
},
"ValueViewLink": {
"type": "string"
},
"HasObverseImage": {
"type": "boolean"
},
"HasReverseImage": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
}
}
},
"CertImage": {
"type": "object",
"properties": {
"Label": {
"type": "string"
},
"ThumbnailUrl": {
"type": "string"
},
"PopupUrl": {
"type": "string"
},
"Width": {
"type": "integer"
},
"Height": {
"type": "integer"
},
"ImageDescription": {
"type": "string"
}
}
},
"OrderDetailModel": {
"type": "object",
"properties": {
"SubmissionNo": {
"type": "string"
},
"OrderNo": {
"type": "string"
},
"CustomerNo": {
"type": "string"
},
"ItemCount": {
"type": "integer"
},
"Service": {
"type": "string"
},
"OrderStatus": {
"type": "string"
},
"DateReceived": {
"type": "string"
},
"DateShipped": {
"type": "string"
},
"Courier": {
"type": "string"
},
"TrackingNo": {
"type": "string"
},
"TrackingUrl": {
"type": "string"
},
"IsCancelled": {
"type": "boolean"
},
"ImageInProcess": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
},
"GradeReady": {
"type": "boolean"
},
"OrderLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineDetail"
}
}
}
},
"OrderLineDetail": {
"type": "object",
"properties": {
"LineNo": {
"type": "integer"
},
"ItemNo": {
"type": "integer"
},
"CertNo": {
"type": "string"
},
"PCGSNo": {
"type": "string"
},
"Description": {
"type": "string"
},
"DisplayGrade": {
"type": "string"
},
"Country": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CoinFactsModel": {
"type": "object",
"properties": {
"PCGSNo": {
"type": "string"
},
"CertNo": {
"type": "string"
},
"Name": {
"type": "string"
},
"Year": {
"type": "integer"
},
"Denomination": {
"type": "string"
},
"Mintage": {
"type": "string"
},
"MintMark": {
"type": "string"
},
"MintLocation": {
"type": "string"
},
"MetalContent": {
"type": "string"
},
"Diameter": {
"type": "number"
},
"Edge": {
"type": "string"
},
"Weight": {
"type": "number"
},
"Country": {
"type": "string"
},
"Grade": {
"type": "string"
},
"Designation": {
"type": "string"
},
"PriceGuideValue": {
"type": "number"
},
"Population": {
"type": "integer"
},
"PopHigher": {
"type": "integer"
},
"CoinFactsLink": {
"type": "string"
},
"Designer": {
"type": "string"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoinFactsImage"
}
},
"CoinFactsNotes": {
"type": "string"
},
"MajorVariety": {
"type": "string"
},
"MinorVariety": {
"type": "string"
},
"DieVariety": {
"type": "string"
},
"AuctionList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuctionItem"
}
},
"SeriesName": {
"type": "string"
},
"Category": {
"type": "string"
},
"HasTrueViewImage": {
"type": "boolean"
},
"ImageReady": {
"type": "boolean"
},
"IsNFCSecure": {
"type": "boolean"
}
}
},
"CoinFactsImage": {
"type": "object",
"properties": {
"Thumbnail": {
"type": "string"
},
"Fullsize": {
"type": "string"
}
}
},
"AuctionItem": {
"type": "object",
"properties": {
"Service": {
"type": "string"
},
"Date": {
"type": "string"
},
"Auctioneer": {
"type": "string"
},
"LotNo": {
"type": "integer"
},
"LotNumV2": {
"type": "string"
},
"SaleName": {
"type": "string"
},
"CertNo": {
"type": "string"
},
"Price": {
"type": "number"
},
"IsCAC": {
"type": "boolean"
},
"AuctionLotUrl": {
"type": "string"
}
}
},
"ImageDetail": {
"type": "object",
"properties": {
"Url": {
"type": "string"
},
"Resolution": {
"type": "string"
},
"Description": {
"type": "string"
}
}
}
},
"responses": {
"NotFound": {
"description": "The specified resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IsValidRequest": {
"type": "boolean",
"example": false
},
"ServerMessage": {
"type": "string",
"example": "No data found."
}
}
}
}
}
},
"Unauthorized": {
"description": "Unauthorized access or invalid credentials.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IsValidRequest": {
"type": "boolean",
"example": false
},
"ServerMessage": {
"type": "string",
"example": "Unauthorized access or invalid credentials."
}
}
}
}
}
},
"BadRequest": {
"description": "Bad request due to invalid or missing parameters.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IsValidRequest": {
"type": "boolean",
"example": false
},
"ServerMessage": {
"type": "string",
"example": "Invalid request parameters."
}
}
}
}
}
},
"InternalServerError": {
"description": "Internal Server Error - problem with the server processing the request.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IsValidRequest": {
"type": "boolean",
"example": false
},
"ServerMessage": {
"type": "string",
"example": "Internal server error or invalid credentials."
}
}
}
}
}
}
}
}
}Numista API
Numista API for accessing numismatic information, including comprehensive coin details, types, issues, pricing, and mints.
GET /typesSearch the catalogue for coin, banknote, and exonumia types.GET /types/{type_id}Retrieve the details about a specific type in the catalogue.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "Numista API",
"version": "3.0",
"description": "Numista API for accessing numismatic information, including comprehensive coin details, types, issues, pricing, and mints."
},
"servers": [
{
"url": "https://api.numista.com/api/v3/DELETETHIS",
"description": "Production server"
}
],
"paths": {
"/types": {
"get": {
"summary": "Search the catalogue for coin, banknote, and exonumia types.",
"operationId": "searchCatalogue",
"security": [
{
"ApiKeyAuth": []
}
],
"parameters": [
{
"in": "query",
"name": "issuer",
"schema": {
"type": "string"
},
"description": "Issuer Id. Returns types from the given issuer only."
},
{
"in": "query",
"name": "count",
"schema": {
"type": "integer",
"default": 50,
"maximum": 50
},
"description": "Number of results per page."
}
],
"responses": {
"200": {
"description": "A list of types matching the query parameters.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"types"
],
"properties": {
"count": {
"type": "integer",
"description": "Total count of results."
},
"types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"category",
"issuer",
"min_year",
"max_year",
"obverse_thumbnail",
"reverse_thumbnail"
],
"properties": {
"issuer": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code representing the issuing country or entity."
},
"name": {
"type": "string",
"description": "Name of the issuing country or entity."
}
}
},
"min_year": {
"type": "integer",
"description": "Earliest year of issue for the type."
},
"max_year": {
"type": "integer",
"description": "Latest year of issue for the type."
},
"obverse_thumbnail": {
"type": "string",
"format": "uri",
"description": "URL to the thumbnail image of the obverse side."
},
"reverse_thumbnail": {
"type": "string",
"format": "uri",
"description": "URL to the thumbnail image of the reverse side."
}
}
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
}
}
},
"/types/{type_id}": {
"get": {
"summary": "Retrieve the details about a specific type in the catalogue.",
"operationId": "getTypeDetails",
"security": [
{
"ApiKeyAuth": []
}
],
"parameters": [
{
"name": "type_id",
"in": "path",
"required": true,
"description": "ID of the type to fetch.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The type has been found. Details are present in the body.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"title",
"category"
],
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of the type on Numista."
},
"url": {
"type": "string",
"format": "uri",
"description": "URL to the type on Numista."
},
"title": {
"type": "string",
"description": "Title of the type."
},
"category": {
"type": "string",
"enum": [
"coin",
"banknote",
"exonumia"
],
"description": "Category of the type."
},
"issuer": {
"$ref": "#/components/schemas/Issuer"
},
"min_year": {
"type": "integer",
"description": "First year the type was produced."
},
"max_year": {
"type": "integer",
"description": "Last year the type was produced."
},
"type": {
"type": "string",
"description": "Type of the item (e.g., Standard circulation coin)."
},
"ruler": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"wikidata_id": {
"type": "string"
}
}
}
},
"value": {
"$ref": "#/components/schemas/Value"
},
"demonetization": {
"type": "object",
"properties": {
"is_demonetized": {
"type": "boolean"
}
}
},
"shape": {
"type": "string",
"description": "Shape of the item."
},
"composition": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
}
},
"technique": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
}
},
"weight": {
"type": "number",
"format": "float",
"description": "Weight in grams."
},
"size": {
"type": "number",
"format": "float",
"description": "Size in millimeters."
},
"thickness": {
"type": "number",
"format": "float",
"description": "Thickness in millimeters."
},
"orientation": {
"type": "string",
"enum": [
"coin",
"medal",
"variable",
"three",
"nine"
],
"description": "Orientation of the coin."
},
"obverse": {
"$ref": "#/components/schemas/CoinSide"
},
"reverse": {
"$ref": "#/components/schemas/CoinSide"
},
"edge": {
"$ref": "#/components/schemas/CoinSide"
},
"mints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mint"
}
},
"comments": {
"type": "string",
"description": "General comments about the type."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reference"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
}
}
}
},
"components": {
"schemas": {
"Type": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of the type on Numista"
},
"title": {
"type": "string",
"description": "Title of the type"
},
"category": {
"type": "string",
"enum": [
"coin",
"banknote",
"exonumia"
],
"description": "Category of the type"
}
}
},
"Issuer": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code representing the issuer"
},
"name": {
"type": "string",
"description": "Name of the issuer"
}
}
},
"Mint": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the mint"
},
"name": {
"type": "string",
"description": "Name of the mint"
},
"place": {
"type": "string",
"description": "Location of the mint"
}
}
},
"Value": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The textual representation of the face value"
},
"numeric_value": {
"type": "number",
"description": "The numeric value of the face value"
},
"currency": {
"type": "string",
"description": "The currency of the face value"
}
}
},
"Reference": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the reference"
},
"code": {
"type": "string",
"description": "Code of the reference catalogue"
},
"title": {
"type": "string",
"description": "Title of the reference catalogue"
}
}
},
"CoinSide": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the coin side"
},
"lettering": {
"type": "string",
"description": "Lettering on the coin side"
}
}
},
"Image": {
"type": "object",
"properties": {
"thumbnail": {
"type": "string",
"format": "uri",
"description": "URL to the thumbnail image"
},
"fullsize": {
"type": "string",
"format": "uri",
"description": "URL to the full-size image"
}
}
}
},
"responses": {
"BadRequest": {
"description": "The request parameters are invalid or missing.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_message": {
"type": "string",
"example": "Invalid value for a parameter or missing value for a mandatory parameter."
}
}
}
}
}
},
"Unauthorized": {
"description": "The request lacks valid authentication credentials for the target resource or the API key is missing.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_message": {
"type": "string",
"example": "Invalid or missing API key."
}
}
}
}
}
},
"NotFound": {
"description": "The server can not find the requested resource. This is also returned when the requested resource is not found in the database.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_message": {
"type": "string",
"example": "The resource with the given ID was not found."
}
}
}
}
}
},
"TooManyRequests": {
"description": "The user has sent too many requests in a given amount of time (\"rate limiting\").",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_message": {
"type": "string",
"example": "Too many simultaneous requests or monthly quota reached."
}
}
}
}
}
},
"InternalServerError": {
"description": "The server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_message": {
"type": "string",
"example": "Internal server error."
}
}
}
}
}
}
}
}
}Numi Firebase Realtime Database API for Ancient Coins
API for querying information about ancient coin issuers from the Firebase Realtime Database, specifically designed for Numi's ancient coin identification process.
GET /Ancient_Coins/Issuer_Details/{Issuer_Name}.jsonRetrieve detailed information about a specific ancient issuerGET /Ancient_Coins/Primary_Issuers.jsonRetrieve all Ancient Primary IssuersGET /Ancient_Coins/Sub_Section_1/{Issuer_Name}.jsonRetrieve all Ancient Sub-Section 1 Issuers based on issuer nameGET /Ancient_Coins/Sub_Section_2/{Issuer_Name}.jsonRetrieve all Ancient Sub-Section 2 Issuers based on issuer nameGET /Ancient_Coins/Sub_Section_3/{Issuer_Name}.jsonRetrieve all Ancient Sub-Section 3 Issuers based on issuer nameGET /Ancient_Coins/Sub_Section_4/{Issuer_Name}.jsonRetrieve all Ancient Sub-Section 4 Issuers based on issuer name
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "Numi Firebase Realtime Database API for Ancient Coins",
"version": "1.0.0",
"description": "API for querying information about ancient coin issuers from the Firebase Realtime Database, specifically designed for Numi's ancient coin identification process."
},
"servers": [
{
"url": "https://numi-6e212-default-rtdb.firebaseio.com/",
"description": "Firebase Realtime Database server for Numi"
}
],
"paths": {
"/Ancient_Coins/Issuer_Details/{Issuer_Name}.json": {
"get": {
"summary": "Retrieve detailed information about a specific ancient issuer",
"operationId": "getAncientIssuerDetails",
"parameters": [
{
"name": "Issuer_Name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientIssuerDetail"
}
}
}
}
}
}
},
"/Ancient_Coins/Primary_Issuers.json": {
"get": {
"summary": "Retrieve all Ancient Primary Issuers",
"operationId": "getAncientPrimaryIssuers",
"parameters": [
{
"name": "Issuer_Name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientSubSectionDetail"
}
}
}
}
}
}
},
"/Ancient_Coins/Sub_Section_1/{Issuer_Name}.json": {
"get": {
"summary": "Retrieve all Ancient Sub-Section 1 Issuers based on issuer name",
"operationId": "getAncientSubSection1",
"parameters": [
{
"name": "Issuer_Name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientSubSectionDetail"
}
}
}
}
}
}
},
"/Ancient_Coins/Sub_Section_2/{Issuer_Name}.json": {
"get": {
"summary": "Retrieve all Ancient Sub-Section 2 Issuers based on issuer name",
"operationId": "getAncientSubSection2",
"parameters": [
{
"name": "Issuer_Name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientSubSectionDetail"
}
}
}
}
}
}
},
"/Ancient_Coins/Sub_Section_3/{Issuer_Name}.json": {
"get": {
"summary": "Retrieve all Ancient Sub-Section 3 Issuers based on issuer name",
"operationId": "getAncientSubSection3",
"parameters": [
{
"name": "Issuer_Name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientSubSectionDetail"
}
}
}
}
}
}
},
"/Ancient_Coins/Sub_Section_4/{Issuer_Name}.json": {
"get": {
"summary": "Retrieve all Ancient Sub-Section 4 Issuers based on issuer name",
"operationId": "getAncientSubSection4",
"parameters": [
{
"name": "Issuer_Name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AncientSubSectionDetail"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AncientIssuerDetail": {
"type": "object",
"properties": {
"Issuer_Id": {
"type": "string"
},
"Name": {
"type": "string"
},
"Parent_Issuer": {
"type": "string",
"nullable": true
},
"Parent_Issuer_Id": {
"type": "string",
"nullable": true
}
}
},
"AncientSubSectionDetail": {
"type": "object",
"properties": {
"Issuer_Id": {
"type": "string"
},
"Issuer_Name": {
"type": "string"
},
"Parent_Issuer": {
"type": "string"
},
"Parent_Issuer_Id": {
"type": "string"
},
"Children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AncientIssuerDetail"
}
}
}
}
}
}
}