Phosphor Public API (v1)

Download OpenAPI specification:Download

Terms of Service

by Phosphor.

Get known contract capabilities

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"abi": [{"property1": { },
"property2": { }
}
],
"name": "string"
}
],
"total_results": 0
}

Get the Application Binary Interface (ABI) for a specific capability

path Parameters

capability

required

string

Responses

Response samples

200

Content type

application/json

{"abi": [{"property1": { },
"property2": { }
}
],
"name": "string"
}

Get all collections by an organization

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit
organization_id required	string <uuid>
collection_id	Array of strings <uuid> [ items <uuid > ] Default: null
network_id	Array of integers <int32> [ items <int32 > ] Default: null

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"base_uri": null,
"contract": "string",
"description": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"max_supply": null,
"media": null,
"name": "string",
"network_id": 0
}
],
"total_results": 0
}

Get a public collection by collection id

path Parameters

collection_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"base_uri": null,
"contract": "string",
"description": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"max_supply": null,
"media": null,
"name": "string",
"network_id": 0
}

Get a public collection capabilities by collection id

path Parameters

collection_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"capabilities": ["ADMIN_MINT_MULTIPLE"
]
}

Get collection stats

path Parameters

collection_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"attributes": [{"count": 0,
"name": "string",
"values": [{"count": 0,
"name": "string"
}
]
}
],
"excluded": ["string"
],
"tokens_indexed": 0
}

Get the contract level metadata

path Parameters

network_id required	string
contract_address required	string

Responses

Response samples

200

Content type

application/json

{"description": null,
"external_link": null,
"image": null,
"name": "string"
}

Get global contract addresses.

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit
network_ids required	Array of integers <int32> [ items <int32 > ]

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"address": "string",
"name": "string",
"network_id": 0
}
],
"total_results": 0
}

Get the item that is redeemable for the given claim token

path Parameters

claim_token

required

string

Responses

Response samples

200

Content type

application/json

{"campaign_id": null,
"is_active": true,
"is_claimed": true,
"item": {"attributes": {"property1": { },
"property2": { }
},
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"listing": null,
"media": {"image": null
},
"token_contract": {"address": null,
"capabilities": ["ADMIN_MINT_MULTIPLE"
],
"deploy_tx_id": null,
"network_id": null,
"symbol": null,
"token_type": "ERC721",
"tx_hash": null
},
"token_id": "string"
},
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"public_item": {"attributes": {"property1": { },
"property2": { }
},
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"contract_address": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"media": {"image": null
},
"network_id": 0,
"token_id": "string",
"token_type": "ERC721"
},
"quantity": 0,
"voucher": null
}

Redeems an email claim based on the claim token and pincode

If the tx_payer is SELLER, the token is immediately transferred to the buyer. If the tx_payer is BUYER, a mint voucher is returned.

path Parameters

claim_token

required

string

Request Body schema: application/json

address	string or null Default: null ChecksumAddress
pin	string or null Default: null SafeString

Responses

Request samples

Payload

Content type

application/json

{"address": null,
"pin": null
}

Response samples

201

Content type

application/json

{"status": "string",
"voucher": null
}

Sends a pincode to the email address to verify the claim

path Parameters

claim_token

required

string

Responses

Response samples

201

Content type

application/json

{"attributes": {"property1": { },
"property2": { }
},
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"listing": null,
"media": {"image": null
},
"token_contract": {"address": null,
"capabilities": ["ADMIN_MINT_MULTIPLE"
],
"deploy_tx_id": null,
"network_id": null,
"symbol": null,
"token_type": "ERC721",
"tx_hash": null
},
"token_id": "string"
}

Get all public items from an organization

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit
organization_id	string <uuid> Default: null
network_ids	Array of integers <int32> [ items <int32 > ] Default: null
attributes	Array of strings Default: null
collection_ids	Array of strings <uuid> [ items <uuid > ] Default: null
token_ids	Array of integers <int32> [ items <int32 > ] Default: null

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"attributes": {"property1": { },
"property2": { }
},
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"contract_address": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"media": {"image": null
},
"network_id": 0,
"token_id": "string",
"token_type": "ERC721"
}
],
"total_results": 0
}

Get a public item by id

path Parameters

item_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"attributes": {"property1": { },
"property2": { }
},
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"contract_address": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"media": {"image": null
},
"network_id": 0,
"token_id": "string",
"token_type": "ERC721"
}

Get item history

path Parameters

item_id

required

string <uuid>

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit
event_type	string Default: null Enum: "MINT" "TRANSFER" "BURN" null

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"data": {"property1": { },
"property2": { }
},
"quantity": 0,
"timestamp": "2019-08-24T14:15:22Z",
"type": "MINT"
}
],
"total_results": 0
}

Get item owners.

path Parameters

item_id

required

string <uuid>

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"address": "string",
"quantity": 0
}
],
"total_results": 0
}

Get listings for the given organization

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit
organization_id required	string <uuid>
item_id	string <uuid> Default: null
collection_id	string <uuid> Default: null
campaign_id	string <uuid> Default: null

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"campaign_id": null,
"collection_id": null,
"contract": "string",
"currency": "USD",
"end_time": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"item_id": null,
"max_per_user": null,
"max_quantity_per_tx": 0,
"network_id": 0,
"payment_providers": ["STRIPE"
],
"policy_type": "ALLOW_LIST",
"price": "string",
"quantity_listed": 0,
"quantity_remaining": 0,
"start_time": null
}
],
"total_results": 0
}

Get Listing for the given listing id

query Parameters

listing_id required	string <uuid>
eth_address	string Default: null ChecksumAddress
email_address	string Default: null SafeString

Responses

Response samples

200

Content type

application/json

{"is_eligible": false,
"quantity_allowed": "string",
"quantity_claimed": "string"
}

Get Listing for the given listing id

path Parameters

listing_id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"campaign_id": null,
"collection_id": null,
"contract": "string",
"currency": "USD",
"end_time": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"item_id": null,
"max_per_user": null,
"max_quantity_per_tx": 0,
"network_id": 0,
"payment_providers": ["STRIPE"
],
"policy_type": "ALLOW_LIST",
"price": "string",
"quantity_listed": 0,
"quantity_remaining": 0,
"start_time": null
}

Get metadata for a specific token in a collection

path Parameters

collection_id required	string <uuid>
token_id required	string

Responses

Get the pending mint vouchers for the ethereum address

path Parameters

eth_address

required

string

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 1000 ] Default: 100 MediumPaginationLimit
contract_address	string Default: null ChecksumAddress
network_id	integer <int32> Default: null

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"contract": "string",
"minter": "string",
"network_id": 0,
"signature": "string",
"voucher": {"currency": "string",
"expiry": 0,
"initial_recipient": "string",
"initial_recipient_amount": "string",
"net_recipient": "string",
"nonce": 0,
"price": "string",
"quantity": 0,
"token_id": "string",
"token_uri": null
}
}
],
"total_results": 0
}

Get the available networks

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [{"id": 0,
"name": "string",
"testnet": true
}
],
"total_results": 0
}

Create a purchase intent

The purchase intent can be made with any provider configured for the listing. The provider must be one of the following: STRIPE, COINBASE. The response data will have provider specific data in the data field.

Request Body schema: application/json

required	object
listing_id required	string <uuid>
provider required	string Enum: "STRIPE" "COINBASE" "MINT_VOUCHER" "EMAIL_CLAIM" "BETA_FREE_MINT"
quantity required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"buyer": {"email": null,
"eth_address": null
},
"listing_id": "5322d4a9-51d2-4408-82fb-01ffecfb8304",
"provider": "STRIPE",
"quantity": 0
}

Response samples

201

Content type

application/json

{"data": null,
"expires_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Request a cancel of a purchase intent for a given purchase intent id.

path Parameters

purchase_intent_id

required

string <uuid>

Responses

Get payment tokens available for the given networks

query Parameters

order_direction	string Default: null Enum: "ASC" "DESC" null
cursor	string Default: null SafeString
limit	number [ 1 .. 100 ] Default: 100 PaginationLimit
network_id required	Array of numbers[ items >= 0 ]

Responses

Response samples

200

Content type

application/json

{"cursor": null,
"has_more": true,
"results": [null
],
"total_results": 0
}