Entries

Entry Endpoints

Client.get_entries(start: int = 0, limit: int = 10, include_payouts: bool = False, include_tradeables: bool = False, include_count: bool = False) → Union[List[jockmkt_sdk.objects.Entry], Tuple[List[jockmkt_sdk.objects.Entry], int]]

obtain information about events a user has entered

Parameters

  • start (int, optional) – Page at which the user wants to start their search, default: 0 (first page of entries)

  • limit (int, optional) – Number of entities the user wants to display, default: 10 (displays 10 recent and upcoming entries)

  • include_payouts (bool, optional) – Option to include payouts of completed entries, default: False

  • include_tradeables (bool, optional) – Option to include entry-relevant objects.Tradeable objects

  • include_count (bool, optional) – Include the total entry count as part of a returned tuple

Returns

A list of objects.Entry objects, or a tuple of the list and an int representing the total number of entries.

Return type

object.Entry | tuple(list[object.Entry], int)

Client.get_entry(entry_id: str, include_event: bool = False, include_payouts: bool = False, include_tradeables: bool = False) → jockmkt_sdk.objects.Entry

Method to obtain information about an event that a user has entered. include_payouts and include_tradeables will only provide info after the event is paid out.

Parameters

  • entry_id (str, required) – The entry_id for which the user wishes to get information (e.g. evt_60dbec530d2197a973c5dddcf6f65e12)

  • include_event (bool, optional) – Include objects.Event information related to the entry

  • include_payouts (bool, optional) – Include payouts for the user’s holdings of a completed event

  • include_tradeables (bool, optional) – Include relevant event object.Tradeable objects

Returns

a list of objects.Entry objects, containing the user’s chosen fields

Return type

objects.Entry

Client.create_entry(event_id: str) → Dict

create an entry to an event given an event_id e.g. evt_60dbec530d2197a973c5dddcf6f65e12

Parameters

event_id (str, required) – the event_id for which the user would like to create an entry to

These methods will return a list of entries, and information about a specific entry respectively.

They return objects.Entry objects.

Entry Object

class jockmkt_sdk.objects.Entry(entry: dict)

object containing information about a user’s entry into an event, such as profit, leaderboard position

Variables

  • entry_id – the entry’s identifier

  • event_id – the event’s identifier

  • leaderboard_pos – the user’s leaderboard position

  • profit – the user’s profit in this entry, not including fees

  • updated_at – when this entry was last updated

  • favorites – a list of favorited tradeables

  • event – objects.Event object containing event specific information

  • payouts – after the event is finished, a list of payouts made to the user for their holdings