SC API

Reference for the scapi API.

WARNING

The query function is blocking, it's recommended to call inside of a thread or job.

Functions

scapi.query

Fetch data for an account.

---@param rid integer
function scapi.query(rid): scapi_rockstar_account

---@param name string
---@param page? integer
function scapi.query(name, page?): scapi_account_pagination

Types

scapi_rockstar_account

Field	Type
name	string
rid	integer
success	bool

scapi_result_info

Field	Type
total	integer
next_page	integer
query	string

scapi_account_pagination

Field	Type
accounts	scapi_rockstar_account[]
paged	scapi_result_info
success	bool

Examples

function query_accounts(name, page)
  local scinfo = scapi.query(name, page)
  if scinfo.success then
    for i, account in ipairs(scinfo.accounts) do
      print('name: ', account.name)
    end

    if scinfo.paged.next_page > 0 then
      query_accounts(name, scinfo.paged.next_page)
    end
  end
end

query_accounts('Rockstar', 0)

local scinfo = scapi.query(1)
if scinfo.success then
  print('Name:', scinfo.name)
end