Deck of Cards API 🃏♠️♦️♣️♥️

This is the Deck of Cards API documentation page. Check out the demo to see it in action.

GET /deck/new
Create a new deck

Parameters

Name Description
cards List of cards to include in the deck
jokers_enabled Include jokers in the deck (true/false)
deck_count Number of decks to create

Example Response

{"success":true,"deck_id":"ExampleDeckID01","shuffled":false,"remaining":52}
GET /deck/{deck_id}
Get deck info

Example Response

{"success":true,"deck_id":"ExampleDeckID01","shuffled":false,"remaining":42,"piles":{"PlayerA":{"remaining":10}}}
GET /deck/{deck_id}/shuffle
Shuffle deck

Parameters

Name Description
remaining Shuffle only the cards that are not in any pile

Example Response

{"success":true,"deck_id":"ExampleDeckID01","shuffled":true,"remaining":48,"piles":{"Player 1":{"remaining":1},"Player 2":{"remaining":3}}}
GET /deck/{deck_id}/deal
Deal cards from deck

Parameters

Name Description
count Number of cards to deal
piles Comma separated list of piles to deal to

Example Response

{"success":true,"deck_id":"ExampleDeckID01","shuffled":true,"remaining":48,"piles":{"Player 1":{"remaining":1},"Player 2":{"remaining":3}}}
GET /deck/{deck_id}/draw/pile/{pile_name}
Draw card(s) from pile

Parameters

Name Description
count Number of cards to draw

Example Response

{"success":true,"deck_id":"ExampleDeckID01","remaining":49,"cards_moved":["3S"],"piles":{"PlayerA":{"remaining":3,"cards":"AS,2S,3S"}}}
GET /deck/{deck_id}/pile/{pile_name}/list
List cards in a pile

Example Response

{"success":true,"deck_id":"ExampleDeckID01","remaining":50,"piles":{"PlayerA":{"remaining":2,"cards":"2S,3S"}}}
GET /deck/{deck_id}/pile/{pile_name}/return
Return card(s) to the stack

Parameters

Name Description
cards Comma separated list of cards to return

Example Response

{"success":true,"deck_id":"ExampleDeckID01","remaining":50,"cards_moved":"AS","piles":{"PlayerA":{"remaining":2,"cards":"2S,3S"}}}
GET /deck/{deck_id}/pile/{pile_name}/pass/pile/{pile2_name}
Pass card(s) to another pile

Parameters

Name Description
cards Comma separated list of cards to pass

Example Response

{"success":true,"deck_id":"ExampleDeckID01","remaining":50,"piles":{"PlayerA":{"remaining":1,"cards":"2S"},"PlayerB":{"remaining":1}}}
GET /deck/{deck_id}/pile/{pile_name}/shuffle
Shuffle a pile

Example Response

{"success":true,"deck_id":"ExampleDeckID01","remaining":50,"piles":{"PlayerA":{"remaining":2,"cards":"3S,2S"}}}