### Standing Points Structure Example Source: https://help.start.gg/en/articles/13813315-rest-api-access-legacy-old Illustrates the structure of the 'standingPoints' array, which details points awarded for different placings in an event. ```APIDOC ### Standing Points Structure The `standingPoints` array provides a lookup for points awarded based on placement in an event. #### Fields - **id** (integer) - Unique identifier for the standing point entry. - **sourceType** (string) - The type of source the points are associated with (e.g., "event"). - **sourceId** (integer) - The ID of the source (e.g., the event ID). - **standing** (integer) - The placement in the source event that awards these points. - **quantity** (integer) - The number of points awarded for the specified standing. #### Example ```json { "standingPoints": [ {"id": 123, "sourceType": "event", "sourceId": 12345, "quantity": 100, "standing": 1}, {"id": 124, "sourceType": "event", "sourceId": 12345, "quantity": 50, "standing": 2}, {"id": 125, "sourceType": "event", "sourceId": 12345, "quantity": 25, "standing": 3}, {"id": 126, "sourceType": "event", "sourceId": 12345, "quantity": 10, "standing": 4}, {"id": 127, "sourceType": "event", "sourceId": 12345, "quantity": 5, "standing": 5} ] } ``` **Note:** The `standingPoints` array acts as a lookup table. Multiple participants achieving the same placement (e.g., 5th place) will reference the same `standingPoint` entry via their `pointIds`. ``` -------------------------------- ### Retrieve Set Details and Tasks Source: https://help.start.gg/en/articles/13813315-rest-api-access-legacy-old Get specific details for a given set, including associated tasks such as check-in information. This endpoint is useful for tracking individual match progress and details. ```APIDOC ## GET /set/{setId} ### Description Retrieves detailed information for a specific set, including its associated tasks. ### Endpoint `https://api.start.gg/set/?expand[]=setTask` ### Parameters #### Path Parameters - **setId** (string) - Required - The unique identifier of the set. #### Query Parameters - **expand[]** (string) - Optional - Specifies additional data to include in the response. `setTask` is used to retrieve tasks associated with the set. ### Response #### Success Response (200) - **setTask** (array) - A list of tasks associated with the set. Check-in tasks have a `type` value of 1, and check-in data is in the `metadata` field. ``` -------------------------------- ### Example Standing Points Structure Source: https://help.start.gg/en/articles/13813315-rest-api-access-legacy-old This JSON structure represents standing points awarded for an event. Each object details the points awarded for a specific standing (placement) in an event, including the event ID and the quantity of points. ```JSON "standingPoints": [ { "id": 123, "sourceType": "event", "sourceId": 12345, "quantity": 100, "standing": 1 }, { "id": 124, "sourceType": "event", "sourceId": 12345, "quantity": 50, "standing": 2 }, { "id": 125, "sourceType": "event", "sourceId": 12345, "quantity": 25, "standing": 3 }, { "id": 126, "sourceType": "event", "sourceId": 12345, "quantity": 10, "standing": 4 }, { "id": 127, "sourceType": "event", "sourceId": 12345, "quantity": 5, "standing": 5 } ] ``` -------------------------------- ### HTML for Embedded Registration Source: https://help.start.gg/en/articles/13813453-embedding-registration Use this iframe code to embed the start.gg registration directly into your website. Ensure your domain is whitelisted by start.gg support. Include 'allow="payment"' if handling payments. ```html ``` -------------------------------- ### Get Standings for a Specific Tournament Source: https://help.start.gg/en/articles/13813315-rest-api-access-legacy-old Retrieve standings for a specific tournament using its league ID. Supports pagination and expanding related data. ```APIDOC ## GET /standing/tournament/[league-id]/page ### Description Retrieves standings for a specific tournament identified by its league ID. By default, returns the top 25 standings. Supports pagination and expanding related data. ### Method GET ### Endpoint /standing/tournament/[league-id]/page?expand[]=participants&expand[]=standingPoints&mutations[]=playerData ### Parameters #### Path Parameters - **league-id** (string) - Required - The unique identifier for the tournament league. #### Query Parameters - **expand[]** (string) - Optional - Specifies related data to include (e.g., participants, standingPoints, playerData). - **mutations[]** (string) - Optional - Specifies mutations to apply to the data. - **per_page** (integer) - Optional - The number of standings to retrieve per page. Defaults to 25. ### Response #### Success Response (200) - **standing** (array) - An array of standing objects. - **standingPoints** (array) - An array of standing points objects, detailing points awarded for specific placings. - **participants** (array) - An array of participant objects (if expanded). - **playerData** (array) - An array of player data objects (if expanded). #### Response Example (Response structure depends on expanded fields. See source for details on standingPoints structure.) ``` -------------------------------- ### Create Lists Source: https://help.start.gg/en/articles/13802320-customizing-text-with-markdown Use asterisks for bulleted lists and numbers for ordered lists. Indent with four spaces to nest list items. ```markdown ### shopping list pt 1 * allen wrenches * gerbil feeders * toilet seats * electric heaters * Trash compactors * juice extractor * shower rods and water meters *** ``` ```markdown ### shopping list pt 2 1. Walkie-talkies - copper wires safety goggles - radial tires *** ``` -------------------------------- ### Get Top 10 Standings for All Events Source: https://help.start.gg/en/articles/13813315-rest-api-access-legacy-old Retrieve the top 10 standings for all events within a specific circuit. This endpoint can be expanded to include participants and player data. ```APIDOC ## GET /standing/[circuit-slug]/getAllEvents ### Description Retrieves the top 10 standings for all events within a given circuit. Supports expanding related data like participants and player data. ### Method GET ### Endpoint /standing/brawlhalla-circuit/getAllEvents?expand[]=participants&mutations[]=playerData&top=10 ### Query Parameters - **expand[]** (string) - Optional - Specifies related data to include (e.g., participants, playerData). - **mutations[]** (string) - Optional - Specifies mutations to apply to the data. - **top** (integer) - Optional - The number of top standings to retrieve. Defaults to 10 if not specified for this specific example. ### Response #### Success Response (200) - **standing** (array) - An array of standing objects. - **participants** (array) - An array of participant objects (if expanded). - **playerData** (array) - An array of player data objects (if expanded). #### Response Example (Response structure depends on expanded fields. See source for details on entityType and entityId for linking standings to players.) ``` -------------------------------- ### Create Hyperlinks Source: https://help.start.gg/en/articles/13802320-customizing-text-with-markdown Use `[Link Text](URL)` for text links and `![Alt text](URL)` for image links. HTML anchors can also be used for image links. ```markdown [This text goes to the startgg homepage!](http://start.gg) ``` ```html ![Name of image](direct link to image) ```