client

package
v0.0.0-...-9ea3345 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 7, 2022 License: MIT Imports: 11 Imported by: 0

README

iRacing documentation

{
  "car": {
    "assets": {
      "link": "https://members-ng.iracing.com/data/car/assets",
      "note": [
        "image paths are relative to https://images-static.iracing.com/"
      ]
    },
    "get": {
      "link": "https://members-ng.iracing.com/data/car/get"
    }
  },
  "carclass": {
    "get": {
      "link": "https://members-ng.iracing.com/data/carclass/get"
    }
  },
  "constants": {
    "divisions": {
      "link": "https://members-ng.iracing.com/data/constants/divisions",
      "note": "Constant; returned directly as an array of objects"
    }
  },
  "league": {
    "get": {
      "link": "https://members-ng.iracing.com/data/league/get",
      "parameters": {
        "league_id": {
          "type": "number",
          "required": true
        },
        "include_licenses": {
          "type": "boolean",
          "note": "For faster responses, only request when necessary."
        }
      }
    }
  },
  "lookup": {
    "get": {
      "link": "https://members-ng.iracing.com/data/lookup/get",
      "note": "?weather=weather_wind_speed_units&weather=weather_wind_speed_max&weather=weather_wind_speed_min&licenselevels=licenselevels"
    },
    "licenses": {
      "link": "https://members-ng.iracing.com/data/lookup/licenses"
    }
  },
  "member": {
    "get": {
      "link": "https://members-ng.iracing.com/data/member/get",
      "parameters": {
        "cust_ids": {
          "type": "numbers",
          "required": true,
          "note": "?cust_ids=2,3,4"
        },
        "include_licenses": {
          "type": "boolean"
        }
      }
    },
    "info": {
      "link": "https://members-ng.iracing.com/data/member/info",
      "note": "Always the authenticated member."
    }
  },
  "results": {
    "get": {
      "link": "https://members-ng.iracing.com/data/results/get",
      "note": "Get the results of a subsession, if authorized to view them. series_logo image paths are relative to https://images-static.iracing.com/img/logos/series/",
      "parameters": {
        "subsession_id": {
          "type": "number",
          "required": true
        },
        "include_licenses": {
          "type": "boolean"
        }
      }
    },
    "event_log": {
      "link": "https://members-ng.iracing.com/data/results/event_log",
      "parameters": {
        "subsession_id": {
          "type": "number",
          "required": true
        },
        "simsession_number": {
          "type": "number",
          "required": true,
          "note": "The main event is 0; the preceding event is -1, and so on."
        }
      }
    },
    "lap_chart_data": {
      "link": "https://members-ng.iracing.com/data/results/lap_chart_data",
      "parameters": {
        "subsession_id": {
          "type": "number",
          "required": true
        },
        "simsession_number": {
          "type": "number",
          "required": true,
          "note": "The main event is 0; the preceding event is -1, and so on."
        }
      }
    },
    "lap_data": {
      "link": "https://members-ng.iracing.com/data/results/lap_data",
      "parameters": {
        "subsession_id": {
          "type": "number",
          "required": true
        },
        "simsession_number": {
          "type": "number",
          "required": true,
          "note": "The main event is 0; the preceding event is -1, and so on."
        },
        "cust_id": {
          "type": "number",
          "note": "Required if the subsession was a single-driver event. Optional for team events. If omitted for a team event then the laps driven by all the team's drivers will be included."
        },
        "team_id": {
          "type": "number",
          "note": "Required if the subsession was a team event."
        }
      }
    },
    "season_results": {
      "link": "https://members-ng.iracing.com/data/results/season_results",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "event_type": {
          "type": "number",
          "note": "Retrict to one event type: 2 - Practice; 3 - Qualify; 4 - Time Trial; 5 - Race"
        },
        "race_week_num": {
          "type": "number",
          "note": "The first race week of a season is 0."
        }
      }
    }
  },
  "series": {
    "seasons": {
      "link": "https://members-ng.iracing.com/data/series/seasons",
      "parameters": {
        "include_series": {
          "type": "boolean"
        }
      }
    },
    "stats_series": {
      "link": "https://members-ng.iracing.com/data/series/stats_series",
      "note": "To get series and seasons for which standings should be available, filter the list by official: true."
    }
  },
  "stats": {
    "member_career": {
      "link": "https://members-ng.iracing.com/data/stats/member_career",
      "parameters": {
        "cust_id": {
          "type": "number",
          "note": "Defaults to the authenticated member."
        }
      }
    },
    "member_division": {
      "link": "https://members-ng.iracing.com/data/stats/member_division",
      "note": "Divisions are 0-based: 0 is Division 1, 10 is Rookie. See /data/constants/divisons for more information. Always for the authenticated member.",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "event_type": {
          "type": "number",
          "required": true,
          "note": "The event type code for the division type: 4 - Time Trial; 5 - Race"
        }
      }
    },
    "member_recent_races": {
      "link": "https://members-ng.iracing.com/data/stats/member_recent_races",
      "parameters": {
        "cust_id": {
          "type": "number",
          "note": "Defaults to the authenticated member."
        }
      }
    },
    "member_summary": {
      "link": "https://members-ng.iracing.com/data/stats/member_summary",
      "parameters": {
        "cust_id": {
          "type": "number",
          "note": "Defaults to the authenticated member."
        }
      }
    },
    "member_yearly": {
      "link": "https://members-ng.iracing.com/data/stats/member_yearly",
      "parameters": {
        "cust_id": {
          "type": "number",
          "note": "Defaults to the authenticated member."
        }
      }
    },
    "season_driver_standings": {
      "link": "https://members-ng.iracing.com/data/stats/season_driver_standings",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "note": "The first race week of a season is 0."
        }
      }
    },
    "season_supersession_standings": {
      "link": "https://members-ng.iracing.com/data/stats/season_supersession_standings",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "note": "The first race week of a season is 0."
        }
      }
    },
    "season_team_standings": {
      "link": "https://members-ng.iracing.com/data/stats/season_team_standings",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "note": "The first race week of a season is 0."
        }
      }
    },
    "season_tt_standings": {
      "link": "https://members-ng.iracing.com/data/stats/season_tt_standings",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "note": "The first race week of a season is 0."
        }
      }
    },
    "season_tt_results": {
      "link": "https://members-ng.iracing.com/data/stats/season_tt_results",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "required": true,
          "note": "The first race week of a season is 0."
        }
      }
    },
    "season_qualify_results": {
      "link": "https://members-ng.iracing.com/data/stats/season_qualify_results",
      "parameters": {
        "season_id": {
          "type": "number",
          "required": true
        },
        "car_class_id": {
          "type": "number",
          "required": true
        },
        "race_week_num": {
          "type": "number",
          "required": true,
          "note": "The first race week of a season is 0."
        }
      }
    }
  },
  "track": {
    "assets": {
      "link": "https://members-ng.iracing.com/data/track/assets",
      "note": [
        "image paths are relative to https://images-static.iracing.com/"
      ]
    },
    "get": {
      "link": "https://members-ng.iracing.com/data/track/get"
    }
  }
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	Client    *http.Client
	CookieJar *cookiejar.Jar
	// contains filtered or unexported fields
}

func New 

func New() *Client

func (*Client) GetCarAssets 

func (c *Client) GetCarAssets() (*response.CarAssetsResponse, error)

func (*Client) GetCarClass 

func (c *Client) GetCarClass() (*response.CarClassResponse, error)

func (*Client) GetCars 

func (c *Client) GetCars() (*response.Car, error)

func (*Client) GetDivisions 

func (c *Client) GetDivisions() (*response.Divisions, error)

func (*Client) GetMember 

func (c *Client) GetMember(custId int) (*response.MemberResponse, error)

func (*Client) GetMemberRecentRaces 

func (c *Client) GetMemberRecentRaces(custId int) (*response.RecentRacesResponse, error)

func (*Client) GetMemberSummary 

func (c *Client) GetMemberSummary(custId int) (*response.MemberSummary, error)

func (*Client) GetMemberYearly 

func (c *Client) GetMemberYearly(custId int) (*response.MemberYearly, error)

func (*Client) GetSession 

func (c *Client) GetSession(subsessionId int) (*response.Session, error)

func (*Client) Login 

func (c *Client) Login(email, password string) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.