casparser

package module
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 18, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

README

Cas Parser Go API Library

Go Reference

The Cas Parser Go library provides convenient access to the Cas Parser REST API from applications written in Go.

It is generated with Stainless.

Installation

import (
	"github.com/CASParser/cas-parser-go" // imported as casparser
)

Or to pin the version:

go get -u 'github.com/CASParser/cas-parser-go@v0.0.2'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/CASParser/cas-parser-go"
	"github.com/CASParser/cas-parser-go/option"
)

func main() {
	client := casparser.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("CAS_PARSER_API_KEY")
	)
	unifiedResponse, err := client.CasParser.SmartParse(context.TODO(), casparser.CasParserSmartParseParams{
		Password: casparser.String("ABCDF"),
		PdfURL:   casparser.String("https://your-cas-pdf-url-here.com"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", unifiedResponse.DematAccounts)
}
Request fields

The casparser library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `json:"...,required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, casparser.String(string), casparser.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := casparser.ExampleParams{
	ID:   "id_xxx",                // required property
	Name: casparser.String("..."), // optional property

	Point: casparser.Point{
		X: 0,                // required field will serialize as 0
		Y: casparser.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: casparser.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[casparser.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of it's variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

All fields in response structs are ordinary value types (not pointers or wrappers). Response structs also include a special JSON field containing metadata about each property.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := casparser.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.CasParser.SmartParse(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *casparser.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.CasParser.SmartParse(context.TODO(), casparser.CasParserSmartParseParams{
	Password: casparser.String("ABCDF"),
	PdfURL:   casparser.String("https://you-cas-pdf-url-here.com"),
})
if err != nil {
	var apierr *casparser.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/v4/smart/parse": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.CasParser.SmartParse(
	ctx,
	casparser.CasParserSmartParseParams{
		Password: casparser.String("ABCDF"),
		PdfURL:   casparser.String("https://you-cas-pdf-url-here.com"),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as io.Reader. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper casparser.File(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := casparser.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.CasParser.SmartParse(
	context.TODO(),
	casparser.CasParserSmartParseParams{
		Password: casparser.String("ABCDF"),
		PdfURL:   casparser.String("https://you-cas-pdf-url-here.com"),
	},
	option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
unifiedResponse, err := client.CasParser.SmartParse(
	context.TODO(),
	casparser.CasParserSmartParseParams{
		Password: casparser.String("ABCDF"),
		PdfURL:   casparser.String("https://you-cas-pdf-url-here.com"),
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", unifiedResponse)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]any

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: casparser.String("John"),
    },
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := casparser.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(b bool) param.Opt[bool]

func BoolPtr 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (CAS_PARSER_API_KEY, CAS_PARSER_BASE_URL). This should be used to initialize new clients.

func File 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

func Opt[T comparable](v T) param.Opt[T]

func Ptr 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr 

func StringPtr(v string) *string

func Time 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr 

func TimePtr(v time.Time) *time.Time

Types

type CasGeneratorGenerateCasParams 

type CasGeneratorGenerateCasParams struct {
	// Email address to receive the CAS document
	Email string `json:"email,required"`
	// Start date for the CAS period (format YYYY-MM-DD)
	FromDate string `json:"from_date,required"`
	// Password to protect the generated CAS PDF
	Password string `json:"password,required"`
	// End date for the CAS period (format YYYY-MM-DD)
	ToDate string `json:"to_date,required"`
	// PAN number (optional for some CAS authorities)
	PanNo param.Opt[string] `json:"pan_no,omitzero"`
	// CAS authority to generate the document from (currently only kfintech is
	// supported)
	//
	// Any of "kfintech", "cams", "cdsl", "nsdl".
	CasAuthority CasGeneratorGenerateCasParamsCasAuthority `json:"cas_authority,omitzero"`
	// contains filtered or unexported fields
}

func (CasGeneratorGenerateCasParams) MarshalJSON 

func (r CasGeneratorGenerateCasParams) MarshalJSON() (data []byte, err error)

func (*CasGeneratorGenerateCasParams) UnmarshalJSON 

func (r *CasGeneratorGenerateCasParams) UnmarshalJSON(data []byte) error

type CasGeneratorGenerateCasParamsCasAuthority 

type CasGeneratorGenerateCasParamsCasAuthority string

CAS authority to generate the document from (currently only kfintech is supported) 

const (
	CasGeneratorGenerateCasParamsCasAuthorityKfintech CasGeneratorGenerateCasParamsCasAuthority = "kfintech"
	CasGeneratorGenerateCasParamsCasAuthorityCams     CasGeneratorGenerateCasParamsCasAuthority = "cams"
	CasGeneratorGenerateCasParamsCasAuthorityCdsl     CasGeneratorGenerateCasParamsCasAuthority = "cdsl"
	CasGeneratorGenerateCasParamsCasAuthorityNsdl     CasGeneratorGenerateCasParamsCasAuthority = "nsdl"
)

type CasGeneratorGenerateCasResponse 

type CasGeneratorGenerateCasResponse struct {
	Msg    string `json:"msg"`
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Msg         respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CasGeneratorGenerateCasResponse) RawJSON 

func (r CasGeneratorGenerateCasResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CasGeneratorGenerateCasResponse) UnmarshalJSON 

func (r *CasGeneratorGenerateCasResponse) UnmarshalJSON(data []byte) error

type CasGeneratorService 

type CasGeneratorService struct {
	Options []option.RequestOption
}

CasGeneratorService contains methods and other services that help with interacting with the CAS Parser API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCasGeneratorService method instead.

func NewCasGeneratorService 

func NewCasGeneratorService(opts ...option.RequestOption) (r CasGeneratorService)

NewCasGeneratorService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CasGeneratorService) GenerateCas 

func (r *CasGeneratorService) GenerateCas(ctx context.Context, body CasGeneratorGenerateCasParams, opts ...option.RequestOption) (res *CasGeneratorGenerateCasResponse, err error)

This endpoint generates CAS (Consolidated Account Statement) documents by submitting a mailback request to the specified CAS authority. Currently only supports KFintech, with plans to support CAMS, CDSL, and NSDL in the future.

type CasParserCamsKfintechParams 

type CasParserCamsKfintechParams struct {
	// Password for the PDF file (if required)
	Password param.Opt[string] `json:"password,omitzero"`
	// Base64 encoded CAS PDF file
	PdfFile param.Opt[string] `json:"pdf_file,omitzero" format:"base64"`
	// URL to the CAS PDF file
	PdfURL param.Opt[string] `json:"pdf_url,omitzero" format:"uri"`
	// contains filtered or unexported fields
}

func (CasParserCamsKfintechParams) MarshalJSON 

func (r CasParserCamsKfintechParams) MarshalJSON() (data []byte, err error)

func (*CasParserCamsKfintechParams) UnmarshalJSON 

func (r *CasParserCamsKfintechParams) UnmarshalJSON(data []byte) error

type CasParserCdslParams 

type CasParserCdslParams struct {
	// Password for the PDF file (if required)
	Password param.Opt[string] `json:"password,omitzero"`
	// Base64 encoded CAS PDF file
	PdfFile param.Opt[string] `json:"pdf_file,omitzero" format:"base64"`
	// URL to the CAS PDF file
	PdfURL param.Opt[string] `json:"pdf_url,omitzero" format:"uri"`
	// contains filtered or unexported fields
}

func (CasParserCdslParams) MarshalJSON 

func (r CasParserCdslParams) MarshalJSON() (data []byte, err error)

func (*CasParserCdslParams) UnmarshalJSON 

func (r *CasParserCdslParams) UnmarshalJSON(data []byte) error

type CasParserNsdlParams 

type CasParserNsdlParams struct {
	// Password for the PDF file (if required)
	Password param.Opt[string] `json:"password,omitzero"`
	// Base64 encoded CAS PDF file
	PdfFile param.Opt[string] `json:"pdf_file,omitzero" format:"base64"`
	// URL to the CAS PDF file
	PdfURL param.Opt[string] `json:"pdf_url,omitzero" format:"uri"`
	// contains filtered or unexported fields
}

func (CasParserNsdlParams) MarshalJSON 

func (r CasParserNsdlParams) MarshalJSON() (data []byte, err error)

func (*CasParserNsdlParams) UnmarshalJSON 

func (r *CasParserNsdlParams) UnmarshalJSON(data []byte) error

type CasParserService 

type CasParserService struct {
	Options []option.RequestOption
}

CasParserService contains methods and other services that help with interacting with the CAS Parser API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCasParserService method instead.

func NewCasParserService 

func NewCasParserService(opts ...option.RequestOption) (r CasParserService)

NewCasParserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CasParserService) CamsKfintech 

func (r *CasParserService) CamsKfintech(ctx context.Context, body CasParserCamsKfintechParams, opts ...option.RequestOption) (res *UnifiedResponse, err error)

This endpoint specifically parses CAMS/KFintech CAS (Consolidated Account Statement) PDF files and returns data in a unified format. Use this endpoint when you know the PDF is from CAMS or KFintech.

func (*CasParserService) Cdsl 

func (r *CasParserService) Cdsl(ctx context.Context, body CasParserCdslParams, opts ...option.RequestOption) (res *UnifiedResponse, err error)

This endpoint specifically parses CDSL CAS (Consolidated Account Statement) PDF files and returns data in a unified format. Use this endpoint when you know the PDF is from CDSL.

func (*CasParserService) Nsdl 

func (r *CasParserService) Nsdl(ctx context.Context, body CasParserNsdlParams, opts ...option.RequestOption) (res *UnifiedResponse, err error)

This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF files and returns data in a unified format. Use this endpoint when you know the PDF is from NSDL.

func (*CasParserService) SmartParse 

func (r *CasParserService) SmartParse(ctx context.Context, body CasParserSmartParseParams, opts ...option.RequestOption) (res *UnifiedResponse, err error)

This endpoint parses CAS (Consolidated Account Statement) PDF files from NSDL, CDSL, or CAMS/KFintech and returns data in a unified format. It auto-detects the CAS type and transforms the data into a consistent structure regardless of the source.

type CasParserSmartParseParams 

type CasParserSmartParseParams struct {
	// Password for the PDF file (if required)
	Password param.Opt[string] `json:"password,omitzero"`
	// Base64 encoded CAS PDF file
	PdfFile param.Opt[string] `json:"pdf_file,omitzero" format:"base64"`
	// URL to the CAS PDF file
	PdfURL param.Opt[string] `json:"pdf_url,omitzero" format:"uri"`
	// contains filtered or unexported fields
}

func (CasParserSmartParseParams) MarshalJSON 

func (r CasParserSmartParseParams) MarshalJSON() (data []byte, err error)

func (*CasParserSmartParseParams) UnmarshalJSON 

func (r *CasParserSmartParseParams) UnmarshalJSON(data []byte) error

type Client 

type Client struct {
	Options      []option.RequestOption
	CasParser    CasParserService
	CasGenerator CasGeneratorService
}

Client creates a struct with services and top level methods that help with interacting with the CAS Parser API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r Client)

NewClient generates a new client with the default option read from the environment (CAS_PARSER_API_KEY, CAS_PARSER_BASE_URL). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned [url.Values] will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Error 

type Error = apierror.Error

type UnifiedResponse 

type UnifiedResponse struct {
	DematAccounts []UnifiedResponseDematAccount `json:"demat_accounts"`
	Insurance     UnifiedResponseInsurance      `json:"insurance"`
	Investor      UnifiedResponseInvestor       `json:"investor"`
	Meta          UnifiedResponseMeta           `json:"meta"`
	MutualFunds   []UnifiedResponseMutualFund   `json:"mutual_funds"`
	Summary       UnifiedResponseSummary        `json:"summary"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		DematAccounts respjson.Field
		Insurance     respjson.Field
		Investor      respjson.Field
		Meta          respjson.Field
		MutualFunds   respjson.Field
		Summary       respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponse) RawJSON 

func (r UnifiedResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponse) UnmarshalJSON 

func (r *UnifiedResponse) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccount 

type UnifiedResponseDematAccount struct {
	// Additional information specific to the demat account type
	AdditionalInfo UnifiedResponseDematAccountAdditionalInfo `json:"additional_info"`
	// Beneficiary Owner ID (primarily for CDSL)
	BoID string `json:"bo_id"`
	// Client ID
	ClientID string `json:"client_id"`
	// Type of demat account
	//
	// Any of "NSDL", "CDSL".
	DematType string `json:"demat_type"`
	// Depository Participant ID
	DpID string `json:"dp_id"`
	// Depository Participant name
	DpName   string                              `json:"dp_name"`
	Holdings UnifiedResponseDematAccountHoldings `json:"holdings"`
	// Total value of the demat account
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		BoID           respjson.Field
		ClientID       respjson.Field
		DematType      respjson.Field
		DpID           respjson.Field
		DpName         respjson.Field
		Holdings       respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccount) RawJSON 

func (r UnifiedResponseDematAccount) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccount) UnmarshalJSON 

func (r *UnifiedResponseDematAccount) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountAdditionalInfo 

type UnifiedResponseDematAccountAdditionalInfo struct {
	// Beneficiary Owner status (CDSL)
	BoStatus string `json:"bo_status"`
	// Beneficiary Owner sub-status (CDSL)
	BoSubStatus string `json:"bo_sub_status"`
	// Beneficiary Owner type (CDSL)
	BoType string `json:"bo_type"`
	// Basic Services Demat Account status (CDSL)
	Bsda string `json:"bsda"`
	// Email associated with the demat account (CDSL)
	Email string `json:"email" format:"email"`
	// List of linked PAN numbers (NSDL)
	LinkedPans []string `json:"linked_pans"`
	// Nominee details (CDSL)
	Nominee string `json:"nominee"`
	// Account status (CDSL)
	Status string `json:"status"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BoStatus    respjson.Field
		BoSubStatus respjson.Field
		BoType      respjson.Field
		Bsda        respjson.Field
		Email       respjson.Field
		LinkedPans  respjson.Field
		Nominee     respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Additional information specific to the demat account type

func (UnifiedResponseDematAccountAdditionalInfo) RawJSON 

func (r UnifiedResponseDematAccountAdditionalInfo) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountAdditionalInfo) UnmarshalJSON 

func (r *UnifiedResponseDematAccountAdditionalInfo) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldings 

type UnifiedResponseDematAccountHoldings struct {
	Aifs                 []UnifiedResponseDematAccountHoldingsAif                `json:"aifs"`
	CorporateBonds       []UnifiedResponseDematAccountHoldingsCorporateBond      `json:"corporate_bonds"`
	DematMutualFunds     []UnifiedResponseDematAccountHoldingsDematMutualFund    `json:"demat_mutual_funds"`
	Equities             []UnifiedResponseDematAccountHoldingsEquity             `json:"equities"`
	GovernmentSecurities []UnifiedResponseDematAccountHoldingsGovernmentSecurity `json:"government_securities"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Aifs                 respjson.Field
		CorporateBonds       respjson.Field
		DematMutualFunds     respjson.Field
		Equities             respjson.Field
		GovernmentSecurities respjson.Field
		ExtraFields          map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldings) RawJSON 

func (r UnifiedResponseDematAccountHoldings) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldings) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldings) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldingsAif 

type UnifiedResponseDematAccountHoldingsAif struct {
	// Additional information specific to the AIF
	AdditionalInfo any `json:"additional_info"`
	// ISIN code of the AIF
	Isin string `json:"isin"`
	// Name of the AIF
	Name string `json:"name"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldingsAif) RawJSON 

func (r UnifiedResponseDematAccountHoldingsAif) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldingsAif) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldingsAif) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldingsCorporateBond 

type UnifiedResponseDematAccountHoldingsCorporateBond struct {
	// Additional information specific to the corporate bond
	AdditionalInfo any `json:"additional_info"`
	// ISIN code of the corporate bond
	Isin string `json:"isin"`
	// Name of the corporate bond
	Name string `json:"name"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldingsCorporateBond) RawJSON 

func (r UnifiedResponseDematAccountHoldingsCorporateBond) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldingsCorporateBond) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldingsCorporateBond) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldingsDematMutualFund 

type UnifiedResponseDematAccountHoldingsDematMutualFund struct {
	// Additional information specific to the mutual fund
	AdditionalInfo any `json:"additional_info"`
	// ISIN code of the mutual fund
	Isin string `json:"isin"`
	// Name of the mutual fund
	Name string `json:"name"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldingsDematMutualFund) RawJSON 

func (r UnifiedResponseDematAccountHoldingsDematMutualFund) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldingsDematMutualFund) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldingsDematMutualFund) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldingsEquity 

type UnifiedResponseDematAccountHoldingsEquity struct {
	// Additional information specific to the equity
	AdditionalInfo any `json:"additional_info"`
	// ISIN code of the equity
	Isin string `json:"isin"`
	// Name of the equity
	Name string `json:"name"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldingsEquity) RawJSON 

func (r UnifiedResponseDematAccountHoldingsEquity) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldingsEquity) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldingsEquity) UnmarshalJSON(data []byte) error

type UnifiedResponseDematAccountHoldingsGovernmentSecurity 

type UnifiedResponseDematAccountHoldingsGovernmentSecurity struct {
	// Additional information specific to the government security
	AdditionalInfo any `json:"additional_info"`
	// ISIN code of the government security
	Isin string `json:"isin"`
	// Name of the government security
	Name string `json:"name"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseDematAccountHoldingsGovernmentSecurity) RawJSON 

func (r UnifiedResponseDematAccountHoldingsGovernmentSecurity) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseDematAccountHoldingsGovernmentSecurity) UnmarshalJSON 

func (r *UnifiedResponseDematAccountHoldingsGovernmentSecurity) UnmarshalJSON(data []byte) error

type UnifiedResponseInsurance 

type UnifiedResponseInsurance struct {
	LifeInsurancePolicies []UnifiedResponseInsuranceLifeInsurancePolicy `json:"life_insurance_policies"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		LifeInsurancePolicies respjson.Field
		ExtraFields           map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseInsurance) RawJSON 

func (r UnifiedResponseInsurance) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseInsurance) UnmarshalJSON 

func (r *UnifiedResponseInsurance) UnmarshalJSON(data []byte) error

type UnifiedResponseInsuranceLifeInsurancePolicy 

type UnifiedResponseInsuranceLifeInsurancePolicy struct {
	// Additional information specific to the policy
	AdditionalInfo any `json:"additional_info"`
	// Name of the life assured
	LifeAssured string `json:"life_assured"`
	// Name of the insurance policy
	PolicyName string `json:"policy_name"`
	// Insurance policy number
	PolicyNumber string `json:"policy_number"`
	// Premium amount
	PremiumAmount float64 `json:"premium_amount"`
	// Frequency of premium payment (e.g., Annual, Monthly)
	PremiumFrequency string `json:"premium_frequency"`
	// Insurance company name
	Provider string `json:"provider"`
	// Status of the policy (e.g., Active, Lapsed)
	Status string `json:"status"`
	// Sum assured amount
	SumAssured float64 `json:"sum_assured"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo   respjson.Field
		LifeAssured      respjson.Field
		PolicyName       respjson.Field
		PolicyNumber     respjson.Field
		PremiumAmount    respjson.Field
		PremiumFrequency respjson.Field
		Provider         respjson.Field
		Status           respjson.Field
		SumAssured       respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseInsuranceLifeInsurancePolicy) RawJSON 

func (r UnifiedResponseInsuranceLifeInsurancePolicy) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseInsuranceLifeInsurancePolicy) UnmarshalJSON 

func (r *UnifiedResponseInsuranceLifeInsurancePolicy) UnmarshalJSON(data []byte) error

type UnifiedResponseInvestor 

type UnifiedResponseInvestor struct {
	// Address of the investor
	Address string `json:"address"`
	// CAS ID of the investor (only for NSDL and CDSL)
	CasID string `json:"cas_id"`
	// Email address of the investor
	Email string `json:"email" format:"email"`
	// Mobile number of the investor
	Mobile string `json:"mobile"`
	// Name of the investor
	Name string `json:"name"`
	// PAN (Permanent Account Number) of the investor
	Pan string `json:"pan"`
	// Postal code of the investor's address
	Pincode string `json:"pincode"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Address     respjson.Field
		CasID       respjson.Field
		Email       respjson.Field
		Mobile      respjson.Field
		Name        respjson.Field
		Pan         respjson.Field
		Pincode     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseInvestor) RawJSON 

func (r UnifiedResponseInvestor) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseInvestor) UnmarshalJSON 

func (r *UnifiedResponseInvestor) UnmarshalJSON(data []byte) error

type UnifiedResponseMeta 

type UnifiedResponseMeta struct {
	// Type of CAS detected and processed
	//
	// Any of "NSDL", "CDSL", "CAMS_KFINTECH".
	CasType string `json:"cas_type"`
	// Timestamp when the response was generated
	GeneratedAt     time.Time                          `json:"generated_at" format:"date-time"`
	StatementPeriod UnifiedResponseMetaStatementPeriod `json:"statement_period"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		CasType         respjson.Field
		GeneratedAt     respjson.Field
		StatementPeriod respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMeta) RawJSON 

func (r UnifiedResponseMeta) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMeta) UnmarshalJSON 

func (r *UnifiedResponseMeta) UnmarshalJSON(data []byte) error

type UnifiedResponseMetaStatementPeriod 

type UnifiedResponseMetaStatementPeriod struct {
	// Start date of the statement period
	From time.Time `json:"from" format:"date"`
	// End date of the statement period
	To time.Time `json:"to" format:"date"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		From        respjson.Field
		To          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMetaStatementPeriod) RawJSON 

func (r UnifiedResponseMetaStatementPeriod) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMetaStatementPeriod) UnmarshalJSON 

func (r *UnifiedResponseMetaStatementPeriod) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFund 

type UnifiedResponseMutualFund struct {
	// Additional folio information
	AdditionalInfo UnifiedResponseMutualFundAdditionalInfo `json:"additional_info"`
	// Asset Management Company name
	Amc string `json:"amc"`
	// Folio number
	FolioNumber string `json:"folio_number"`
	// Registrar and Transfer Agent name
	Registrar string                            `json:"registrar"`
	Schemes   []UnifiedResponseMutualFundScheme `json:"schemes"`
	// Total value of the folio
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Amc            respjson.Field
		FolioNumber    respjson.Field
		Registrar      respjson.Field
		Schemes        respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMutualFund) RawJSON 

func (r UnifiedResponseMutualFund) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFund) UnmarshalJSON 

func (r *UnifiedResponseMutualFund) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFundAdditionalInfo 

type UnifiedResponseMutualFundAdditionalInfo struct {
	// KYC status of the folio
	KYC string `json:"kyc"`
	// PAN associated with the folio
	Pan string `json:"pan"`
	// PAN KYC status
	Pankyc string `json:"pankyc"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		KYC         respjson.Field
		Pan         respjson.Field
		Pankyc      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Additional folio information

func (UnifiedResponseMutualFundAdditionalInfo) RawJSON 

func (r UnifiedResponseMutualFundAdditionalInfo) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFundAdditionalInfo) UnmarshalJSON 

func (r *UnifiedResponseMutualFundAdditionalInfo) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFundScheme 

type UnifiedResponseMutualFundScheme struct {
	// Additional information specific to the scheme
	AdditionalInfo UnifiedResponseMutualFundSchemeAdditionalInfo `json:"additional_info"`
	// Cost of investment
	Cost float64                             `json:"cost"`
	Gain UnifiedResponseMutualFundSchemeGain `json:"gain"`
	// ISIN code of the scheme
	Isin string `json:"isin"`
	// Scheme name
	Name string `json:"name"`
	// Net Asset Value per unit
	Nav float64 `json:"nav"`
	// List of nominees
	Nominees     []string                                     `json:"nominees"`
	Transactions []UnifiedResponseMutualFundSchemeTransaction `json:"transactions"`
	// Type of mutual fund scheme
	//
	// Any of "Equity", "Debt", "Hybrid", "Other".
	Type string `json:"type"`
	// Number of units held
	Units float64 `json:"units"`
	// Current market value of the holding
	Value float64 `json:"value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AdditionalInfo respjson.Field
		Cost           respjson.Field
		Gain           respjson.Field
		Isin           respjson.Field
		Name           respjson.Field
		Nav            respjson.Field
		Nominees       respjson.Field
		Transactions   respjson.Field
		Type           respjson.Field
		Units          respjson.Field
		Value          respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMutualFundScheme) RawJSON 

func (r UnifiedResponseMutualFundScheme) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFundScheme) UnmarshalJSON 

func (r *UnifiedResponseMutualFundScheme) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFundSchemeAdditionalInfo 

type UnifiedResponseMutualFundSchemeAdditionalInfo struct {
	// Financial advisor name (CAMS/KFintech)
	Advisor string `json:"advisor"`
	// AMFI code for the scheme (CAMS/KFintech)
	Amfi string `json:"amfi"`
	// Closing balance units (CAMS/KFintech)
	CloseUnits float64 `json:"close_units"`
	// Opening balance units (CAMS/KFintech)
	OpenUnits float64 `json:"open_units"`
	// RTA code for the scheme (CAMS/KFintech)
	RtaCode string `json:"rta_code"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Advisor     respjson.Field
		Amfi        respjson.Field
		CloseUnits  respjson.Field
		OpenUnits   respjson.Field
		RtaCode     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Additional information specific to the scheme

func (UnifiedResponseMutualFundSchemeAdditionalInfo) RawJSON 

func (r UnifiedResponseMutualFundSchemeAdditionalInfo) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFundSchemeAdditionalInfo) UnmarshalJSON 

func (r *UnifiedResponseMutualFundSchemeAdditionalInfo) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFundSchemeGain 

type UnifiedResponseMutualFundSchemeGain struct {
	// Absolute gain or loss
	Absolute float64 `json:"absolute"`
	// Percentage gain or loss
	Percentage float64 `json:"percentage"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Absolute    respjson.Field
		Percentage  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMutualFundSchemeGain) RawJSON 

func (r UnifiedResponseMutualFundSchemeGain) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFundSchemeGain) UnmarshalJSON 

func (r *UnifiedResponseMutualFundSchemeGain) UnmarshalJSON(data []byte) error

type UnifiedResponseMutualFundSchemeTransaction 

type UnifiedResponseMutualFundSchemeTransaction struct {
	// Transaction amount
	Amount float64 `json:"amount"`
	// Balance units after transaction
	Balance float64 `json:"balance"`
	// Transaction date
	Date time.Time `json:"date" format:"date"`
	// Transaction description
	Description string `json:"description"`
	// Dividend rate (for dividend transactions)
	DividendRate float64 `json:"dividend_rate"`
	// NAV on transaction date
	Nav float64 `json:"nav"`
	// Transaction type detected based on description. Possible values are
	// PURCHASE,PURCHASE_SIP,REDEMPTION,SWITCH_IN,SWITCH_IN_MERGER,SWITCH_OUT,SWITCH_OUT_MERGER,DIVIDEND_PAYOUT,DIVIDEND_REINVESTMENT,SEGREGATION,STAMP_DUTY_TAX,TDS_TAX,STT_TAX,MISC.
	// If dividend_rate is present, then possible values are dividend_rate is
	// applicable only for DIVIDEND_PAYOUT and DIVIDEND_REINVESTMENT.
	Type string `json:"type"`
	// Number of units involved
	Units float64 `json:"units"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Amount       respjson.Field
		Balance      respjson.Field
		Date         respjson.Field
		Description  respjson.Field
		DividendRate respjson.Field
		Nav          respjson.Field
		Type         respjson.Field
		Units        respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseMutualFundSchemeTransaction) RawJSON 

func (r UnifiedResponseMutualFundSchemeTransaction) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseMutualFundSchemeTransaction) UnmarshalJSON 

func (r *UnifiedResponseMutualFundSchemeTransaction) UnmarshalJSON(data []byte) error

type UnifiedResponseSummary 

type UnifiedResponseSummary struct {
	Accounts UnifiedResponseSummaryAccounts `json:"accounts"`
	// Total portfolio value across all accounts
	TotalValue float64 `json:"total_value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Accounts    respjson.Field
		TotalValue  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseSummary) RawJSON 

func (r UnifiedResponseSummary) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseSummary) UnmarshalJSON 

func (r *UnifiedResponseSummary) UnmarshalJSON(data []byte) error

type UnifiedResponseSummaryAccounts 

type UnifiedResponseSummaryAccounts struct {
	Demat       UnifiedResponseSummaryAccountsDemat       `json:"demat"`
	Insurance   UnifiedResponseSummaryAccountsInsurance   `json:"insurance"`
	MutualFunds UnifiedResponseSummaryAccountsMutualFunds `json:"mutual_funds"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Demat       respjson.Field
		Insurance   respjson.Field
		MutualFunds respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseSummaryAccounts) RawJSON 

func (r UnifiedResponseSummaryAccounts) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseSummaryAccounts) UnmarshalJSON 

func (r *UnifiedResponseSummaryAccounts) UnmarshalJSON(data []byte) error

type UnifiedResponseSummaryAccountsDemat 

type UnifiedResponseSummaryAccountsDemat struct {
	// Number of demat accounts
	Count int64 `json:"count"`
	// Total value of demat accounts
	TotalValue float64 `json:"total_value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Count       respjson.Field
		TotalValue  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseSummaryAccountsDemat) RawJSON 

func (r UnifiedResponseSummaryAccountsDemat) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseSummaryAccountsDemat) UnmarshalJSON 

func (r *UnifiedResponseSummaryAccountsDemat) UnmarshalJSON(data []byte) error

type UnifiedResponseSummaryAccountsInsurance 

type UnifiedResponseSummaryAccountsInsurance struct {
	// Number of insurance policies
	Count int64 `json:"count"`
	// Total value of insurance policies
	TotalValue float64 `json:"total_value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Count       respjson.Field
		TotalValue  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseSummaryAccountsInsurance) RawJSON 

func (r UnifiedResponseSummaryAccountsInsurance) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseSummaryAccountsInsurance) UnmarshalJSON 

func (r *UnifiedResponseSummaryAccountsInsurance) UnmarshalJSON(data []byte) error

type UnifiedResponseSummaryAccountsMutualFunds 

type UnifiedResponseSummaryAccountsMutualFunds struct {
	// Number of mutual fund folios
	Count int64 `json:"count"`
	// Total value of mutual funds
	TotalValue float64 `json:"total_value"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Count       respjson.Field
		TotalValue  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (UnifiedResponseSummaryAccountsMutualFunds) RawJSON 

func (r UnifiedResponseSummaryAccountsMutualFunds) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnifiedResponseSummaryAccountsMutualFunds) UnmarshalJSON 

func (r *UnifiedResponseSummaryAccountsMutualFunds) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.21, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.21, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
respjson
shared
constant

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.