dadata

README

Client for DaData.ru

Forked from https://github.com/webdeskltd/dadata.

DaData API v2

Implemented Clean and Suggest methods.

Installation

go get github.com/1xtr/dadata/v2

Usage

import (
	"context"
	"fmt"

	"github.com/1xtr/dadata/v2"
	"github.com/1xtr/dadata/v2/api/suggest"
)

func DaDataExample()  {
	api := dadata.NewSuggestApi()

	params := suggest.RequestParams{
		Query: "ул Свободы",
	}

	suggestions, err := api.Address(context.Background(), &params)
	if err != nil {
		return
	}

	for _, s := range suggestions {
		fmt.Printf("%s", s.Value)
	}
}

Configuration

Credentials

DADATA_API_KEY and DADATA_SECRET_KEY environment variables are used by default to authenticate client.

Custom credential provider may be used by implementing client.CredentialProvider interface.

Also, there is a "simple" credential provider client.Credentials you may utilize.

creds := client.Credentials{
    ApiKeyValue:    "<YOUR_API_KEY>",
    SecretKeyValue: "<YOUR_SECRET_KEY>",
}

api := NewSuggestApi(client.WithCredentialProvider(&creds))

HTTP client

HTTP client may be overridden with custom one:

httpClient := &http.Client{}

api := NewSuggestApi(WithHttpClient(httpClient))

Licence

MIT see LICENSE

Documentation

Index

• Constants
• func NewCleanApi(opts ...client.Option) *clean.Api
• func NewProfileApi(opts ...client.Option) *profile.Api
• func NewStatApi(opts ...client.Option) *stat.Api
• func NewSuggestApi(opts ...client.Option) *suggest.Api

Examples

• NewSuggestApi

Constants

const (
	// EndpointURL is a base API endpoint.
	EndpointURL = "https://dadata.ru/api/v2/"
	// EndpointURLSuggest is a suggestion API endpoint.
	EndpointURLSuggest = "https://suggestions.dadata.ru/suggestions/api/4_1/rs/"
)

Functions

func NewCleanApi

func NewCleanApi(opts ...client.Option) *clean.Api

NewCleanApi provides "clean" API.

func NewProfileApi

func NewProfileApi(opts ...client.Option) *profile.Api

NewProfileApi provides profile related API.

func NewStatApi

func NewStatApi(opts ...client.Option) *stat.Api

NewStatApi provides statistic API.

func NewSuggestApi

func NewSuggestApi(opts ...client.Option) *suggest.Api

NewSuggestApi provides suggestion API.

Example

api := NewSuggestApi()

params := suggest.RequestParams{
	Query: "ул Свободы",
}

suggestions, err := api.Address(context.Background(), &params)
if err != nil {
	return
}

for _, s := range suggestions {
	fmt.Printf("%s", s.Value)
}