> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neural4d.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query remaining balance

> Query the remaining points balance available for later operations.

## Authorizations

<ParamField header="Authorization" type="string" required default={'Bearer ${YOUR_API_KEY}'}>
  Use the bearer token provided through the Neural4D website.
</ParamField>

## Body

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://alb.neural4d.com:3000/api/queryPointsInfo \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  response = requests.request(
      "POST",
      "https://alb.neural4d.com:3000/api/queryPointsInfo",
      headers={
      "Authorization": "Bearer <token>",
      },
  )
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch("https://alb.neural4d.com:3000/api/queryPointsInfo", {
    method: "POST",
    headers: {
      "Authorization": "Bearer <token>"
    },
  });
  const data = await response.json();
  console.log(data);
  ```

  ```typescript TypeScript theme={null}
  const response: Response = await fetch("https://alb.neural4d.com:3000/api/queryPointsInfo", {
    method: "POST",
    headers: {
      "Authorization": "Bearer <token>"
    },
  });
  const data = await response.json();
  console.log(data);
  ```

  ```java Java theme={null}
  import java.net.URI;
  import java.net.http.*;

  HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://alb.neural4d.com:3000/api/queryPointsInfo"))
      .header("Authorization", "Bearer <token>")
      .method("POST", HttpRequest.BodyPublishers.noBody())
      .build();
  HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
  System.out.println(response.body());
  ```

  ```go Go theme={null}
  package main

  import (
    "fmt"
    "io"
    "net/http"
    "strings"
  )

  payload := nil
  req, _ := http.NewRequest("POST", "https://alb.neural4d.com:3000/api/queryPointsInfo", payload)
  req.Header.Set("Authorization", "Bearer <token>")
  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()
  bodyBytes, _ := io.ReadAll(resp.Body)
  fmt.Println(string(bodyBytes))
  ```

  ```ruby Ruby theme={null}
  require "net/http"
  require "json"

  uri = URI("https://alb.neural4d.com:3000/api/queryPointsInfo")
  request = Net::HTTP::Post.new(uri)
  request["Authorization"] = "Bearer <token>"

  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
  puts response.body
  ```

  ```php PHP theme={null}
  <?php

  $ch = curl_init("https://alb.neural4d.com:3000/api/queryPointsInfo");
  curl_setopt_array($ch, [
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => ["Authorization: Bearer <token>"],
  ]);
  $response = curl_exec($ch);
  curl_close($ch);
  echo $response;
  ```

  ```csharp C# theme={null}
  using System.Net.Http;
  using System.Text;

  using var client = new HttpClient();
  using var request = new HttpRequestMessage(HttpMethod.Post, "https://alb.neural4d.com:3000/api/queryPointsInfo");
  request.Headers.TryAddWithoutValidation("Authorization", "Bearer <token>");
  using var response = await client.SendAsync(request);
  Console.WriteLine(await response.Content.ReadAsStringAsync());
  ```
</RequestExample>

## Response

<Tabs sync={false}>
  <Tab title="200">
    Remaining points information

    <ResponseField name="statusType" type="enum<integer>" required>
      Query status. `0` means the result is valid and `-1` means the result is invalid.

      Available options: `-1`, `0`.
    </ResponseField>

    <ResponseField name="data" type="object" required>
      Current point balances grouped by point type.

      <Expandable title="child attributes">
        <ResponseField name="total_points" pre={["data."]} type="integer" required>
          Total points currently available to the account.
        </ResponseField>

        <ResponseField name="monthly_bonus_points" pre={["data."]} type="integer" required>
          Available points granted by the monthly plan.
        </ResponseField>

        <ResponseField name="permanent_points" pre={["data."]} type="integer" required>
          Available permanent points without a monthly expiration.
        </ResponseField>

        <ResponseField name="year_points" pre={["data."]} type="integer" required>
          Available points granted by the annual plan.
        </ResponseField>

        <ResponseField name="expiration_day" pre={["data."]} type="string | null" required>
          Expiration day for time-limited points when present.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="message" type="string" required>
      Human-readable point balance query result.
    </ResponseField>
  </Tab>
</Tabs>

<ResponseExample>
  ```json 200 success theme={null}
  {
    "statusType": 0,
    "data": {
      "total_points": 54335,
      "monthly_bonus_points": 0,
      "permanent_points": 54335,
      "year_points": 0,
      "expiration_day": null
    },
    "message": "Get the points info successfully"
  }
  ```
</ResponseExample>
