Neynar Documentation

Buy storage

cURL

curl --request POST \
  --url https://api.neynar.com/v2/farcaster/storage/buy/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --header 'x-wallet-id: <x-wallet-id>' \
  --data '
{
  "fid": 1,
  "idem": "<string>",
  "units": 1
}
'  

Python

import requests

url = "https://api.neynar.com/v2/farcaster/storage/buy/"

payload = {
    "fid": 1,
    "idem": "<string>",
    "units": 1
}
headers = {
    "x-wallet-id": "<x-wallet-id>",
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {
    'x-wallet-id': '<x-wallet-id>',
    'x-api-key': 'NEYNAR_API_DOCS',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({fid: 1, idem: '<string>', units: 1})
};

fetch('https://api.neynar.com/v2/farcaster/storage/buy/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neynar.com/v2/farcaster/storage/buy/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fid' => 1,
    'idem' => '<string>',
    'units' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: NEYNAR_API_DOCS",
    "x-wallet-id: <x-wallet-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

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

func main() {

url := "https://api.neynar.com/v2/farcaster/storage/buy/"

payload := strings.NewReader("{\n  \"fid\": 1,\n  \"idem\": \"<string>\",\n  \"units\": 1\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-wallet-id", "<x-wallet-id>")
    req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/storage/buy/")
  .header("x-wallet-id", "<x-wallet-id>")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/json")
  .body("{\n  \"fid\": 1,\n  \"idem\": \"<string>\",\n  \"units\": 1\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/storage/buy/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-wallet-id"] = '<x-wallet-id>'
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fid\": 1,\n  \"idem\": \"<string>\",\n  \"units\": 1\n}"

response = http.request(request)
puts response.read_body

Response Examples

Success Response

{  
  "allocations": [  
    {  
      "expiry": "2024-10-08T22:03:49.000Z",  
      "object": "storage_allocation",  
      "timestamp": "2023-10-09T22:03:49.000Z",  
      "units": 10,  
      "user": {  
        "fid": 3,  
        "object": "user_dehydrated",  
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",  
        "display_name": "<string>",  
        "pfp_url": "<string>",  
        "score": 123,  
        "username": "<string>"  
      }  
    }  
  ],  
  "total_active_units": 13  
}

Error Responses

1. Invalid Field

{  
  "code": "InvalidField",  
  "errors": [  
    {  
      "code": "<string>",  
      "expected": "<string>",  
      "message": "<string>",  
      "path": [  
        "<string>"  
      ],  
      "received": "<string>"  
    }  
  ],  
  "message": "Invalid query parameters"  
}

2. Missing Wallet ID

{  
  "code": "RequiredField",  
  "message": "x-wallet-id header is required"  
}

3. Invalid Wallet ID

{  
  "code": "InvalidWalletId",  
  "message": "The provided wallet_id is invalid or not found."  
}

4. Insufficient Funds

{  
  "code": "InsufficientFunds",  
  "message": "Wallet does not have enough balance to complete this transaction."  
}

What You’re Paying For

When you buy storage with a wallet_id:

• Transaction Execution: Neynar handles gas estimation, retries, and monitoring

Storage Units Explained

• Duration: 1 year from purchase
• Network: Optimism mainnet
• Renewal: Must be renewed annually