GET

Look up user accounts by their Stellar address or id

Types of searches available:

By name: Resolve a Stellar address into an account
By id: Resolve an account id into an account

Query Params

q string required
type string enum required

nameid

Responses

200

Response Body

object

account_id string
stellar_address string
memo_type string
memo string

400

Bad Request

Response Body

object

status number required

HTTP status code
detail string required

Human-readable error message
error string required

Human-readable error message
name string required

Error code
requestId string required

Client request id

curl --request GET \ --url 'https://app.bitgo-test.com/api/v2/xlm/federation?q=string&type=name' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v2/xlm/federation?q=string&type=name'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/xlm/federation?q=string&type=name") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v2/xlm/federation?q=string&type=name', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/xlm/federation?q=string&type=name" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)