Skip to content

You're viewing the prerelease documentation siteContent here is for testing and may differ from the live docs.

Go to live docs

Client Libraries

Use these client libraries to call the Onetime Secret API from your application or scripts.

These libraries are maintained by Onetime Secret. Follow each SDK’s documentation for installation and usage. Check package availability before installing an SDK. The identifiers below come from each repository’s manifest and can differ from its name.

Each official SDK supports API v2 and lets you choose a regional API host or a self-hosted base URL. API and host support were checked against the SDK READMEs on 2026-11-02.

For a language-independent API v2 example, use the HTTP quick start.

Package identifier (npm): @onetimesecret/sdk

onetimesecret-js

Quick start

Artifact identifier (Maven): com.onetimesecret:onetimesecret-kotlin

onetimesecret-kotlin

Quick start

Module: OnetimeSecret

onetimesecret-powershell

Quick start · Installation

Package identifier (PyPI): onetime-secret; import: onetimesecret

onetimesecret-py

Quick start

RubyGems: onetimesecret

onetimesecret-ruby

Quick start

Crate identifier: onetimesecret

onetimesecret-rust

Quick start

SwiftPM product: OnetimeSecret

onetimesecret-ios

Quick start · Installation

Availability checked on 2026-11-02: no public registry listings were found for the JavaScript, Kotlin, Python or Rust packages. The Ruby gem was available; PowerShell Gallery availability of the official module was not verified. Swift installs from its Git repository through Swift Package Manager.

The libraries below are community-maintained. Most of these libraries predate API v2 and the regional domains, so they typically call the deprecated v1 endpoints against onetimesecret.com — check each entry’s status note, and verify a library works against your region or self-hosted instance before depending on it.

Language Library Last activity¹ Regional / custom domain
Go go-onetimesecret 2026-05 US host
Python onetimesecret-cli 2024-11 US / EU region option
Go otsgo 2024-03 not documented
PowerShell OneTimeSecret 2021-06 custom base URL
Bash onetimesecret-bash 2020-05 custom host
Python py_onetimesecret 2019-05 ❌ (Python 2-era)
C# OneTimeSharp 2018-05 ❌
Java onetime-java 2014-06 self-hosted URL only
Perl Net::OneTimeSecret 2012-02 ❌

¹ Activity dates and compatibility notes reflect the last community-library audit in 2026-07. They were not re-audited for this official SDK update.

GitHub page - onetimesecret-cli by slashpass — community-maintained (last commit 2024-11). Supports a region option (us / eu).

For new Python integrations, choose an official SDK from the SDKs above. The following examples use community packages.

from onetimesecret import OneTimeSecretCli
cli = OneTimeSecretCli(ONETIMESECRET_USER, ONETIMESECRET_KEY)
cli.create_link("secret") # return a link like https://onetimesecret.com/secret/xxxxxxxxxxx

GitHub page - py_onetimesecret by Vladislav Stepanov — unmaintained (last commit 2019; the example below is Python 2). Uses the deprecated v1 API against onetimesecret.com only.

from onetimesecret import OneTimeSecret
o = OneTimeSecret("YOUR_EMAIL", "YOUR_OTS_APIKEY")
secret = o.share(u"test")
print o.retrieve_secret(secret["secret_key"])
# {u'secret_key': u'dtr7ixukiolpx1i4i87kahmhyoy2q65',
# u'value': u'test'}

Net::OneTimeSecret on CPAN by Kyle Dawkins — unmaintained (last release 0.04, 2012-02). Predates API v2 and regional domains.

#!/usr/bin/env perl
use Net::OneTimeSecret;
# Note: replace these with yours in order for this to work!
my $customerId = 'YOUR_EMAIL';
my $testApiKey = 'YOUR_OTS_APIKEY';
my $api = Net::OneTimeSecret->new( $customerId, $testApiKey );
my $result = $api->shareSecret( 'Jazz, jazz and more jazz.',
passphrase => 'thepassword',
recipient => 'kyle@shoffle.com',
ttl => 7200,
);
printf( "%s\n", $result->{secret_key} );
my $secret = $api->retrieveSecret( $result->{secret_key}, passphrase => "thepassword" );
printf( "%s\n", $secret->{value} );

GitHub page - onetime-java by Marcin Pawlowski — unmaintained (last commit 2014-06). Takes an instance URL, so it may work self-hosted, but it predates API v2.

OneTimeSecret ots = new OneTimeSecretRestImpl(
"https://path/to/ots/instance",
"ots-username",
"ots-apikey");
GenerateResponse generateResponse = ots.generate(
new GenerateRequest.Builder()
.withPassphrase("supersecret")
.build());
RetrieveResponse retrieveResponse = ots.retrieve(
new RetrieveRequest.Builder()
.withSecretKey(generateResponse.getSecretKey())
.withPassphrase("supersecret")
.build());
assertEquals(generateResponse.getValue(), retrieveResponse.getValue());

GitHub page - OneTimeSharp by Vladislav Stepanov — unmaintained (last commit 2018-05). Uses the deprecated v1 API against onetimesecret.com only.

// You can use OneTimeSharp in any of your projects which are compatible with .NET (4.0+) or Mono (2.10.8+).
using VStepanov.OneTimeSharp;
class Test
{
static void Main(string[] args)
{
var ots = new OneTimeSecret("YOUR_EMAIL", "YOUR_OTS_APIKEY");
var generated = ots.GenerateSecret();
Console.WriteLine(generated.Value); // LR*?us*A(UT*
Console.WriteLine(generated.SecretKey); // ikzx3m77j5by8411cg5lk5fvfylvl0i
Console.WriteLine(ots.GetSecretLink(generated)); // https://onetimesecret.com/secret/ikzx3m77j5by8411cg5lk5fvfylvl0i
var shared = ots.ShareSecret("Hello, OTS!");
Console.WriteLine(shared.MetadataKey); // kd6rgsucl98qbgu9eavjq4k5sdxsom0
Console.WriteLine(ots.GetMetadataLink(shared)); // https://onetimesecret.com/private/kd6rgsucl98qbgu9eavjq4k5sdxsom0
}
}

GitHub page - go-onetimesecret by Corbalt — community-maintained (last commit 2026-05, updated for the us.onetimesecret.com host). Includes a CLI.

import ots "github.com/corbaltcode/go-onetimesecret"
client := ots.Client{
Username: "user@example.com",
Key: "my api key",
}
metadata, err := client.Put("the launch codes", "passphrase", 0, "")
if err != nil {
// handle error
}
secret, err := client.Get(metadata.SecretKey, "passphrase")
if err != nil {
// handle error
}
// prints "the launch codes"
print(secret)
Terminal window
$ go install github.com/corbaltcode/go-onetimesecret/cmd/ots@latest
$ ots put 'what is essential is invisible to the eye'
hdjk6p0ozf61o7n6pbaxy4in8zuq7sm ifipvdpeo8oy6r8ryjbu8y7rhm9kty9
$ ots get hdjk6p0ozf61o7n6pbaxy4in8zuq7sm
what is essential is invisible to the eye
$ ots gen
rVjbS$twCJkS 4nwhy7v4fnabayqc5auv4ogh0nfr20 flsdlaun6hwczqu9utmc0vts5xj9xu1
$ ots burn flsdlaun6hwczqu9utmc0vts5xj9xu1
flsdlaun6hwczqu9utmc0vts5xj9xu1

GitHub page - otsgo by Emídio Neto — community-maintained (last release v1.1.0, 2024-03). Regional-domain support not documented.

// Build a new client
client := ots.NewClient(
WithUsername("otsuser@domain.com"),
WithApiKey("xxxxxxxx"),
)
// Send a request with context
ctx := context.Background()
response, err := client.GetStatus(ctx)
if err != nil {
panic(err)
}
fmt.Println(response.Status)

GitHub page - OneTimeSecret by Craig Gumbley — unmaintained (last release 2021-06). Supports a custom -BaseUrl, so it can point at a region or self-hosted instance, but it predates API v2.

The example below is for Craig Gumbley’s community module, whose name is also used by the official SDK. For new PowerShell integrations, choose the official SDK from the PowerShell SDK section above.

Terminal window
# Install from the PowerShell gallery
Install-Module -Name OneTimeSecret -Scope CurrentUser
# Set connection information
Set-OTSAuthorizationToken -Username user@mail.com -APIKey xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Generate a new shared secret
New-OTSSharedSecret -Secret "Very Secret" -Passphrase 1234 -Recipient user@mail.com
# Retrieve a secret
Get-OTSSecret -SecretKey qqevnp70b4uoiax4knzhwlhros6ne7x -Passphrase 1234
# View all functions that are available
Get-Command -Module OneTimeSecret | Select Name

GitHub page - onetimesecret-bash by Eric Engstrom — unmaintained (last commit 2020-05). Supports a custom host via ots_set_host, but predates API v2 and regional domains.

Terminal window
# source for use anonymously (secrets created anonymously)
source ots.bash
# or, source with specific auth credentials
APIUSER="USERNAME"
APIKEY="APIKEY"
source ots.bash -u $APIUSER -k $APIKEY
# check status of server
ots_status
# create a secret and get back the URL
URL=$(echo "secret" | ots_share)
# share a multi line secret via HEREDOC.
URL=$(ots_share <<-EOF
This is a Secret
... on multiple lines
EOF
)
# pass options to share or generate.
URL=$(ots_share ttl=600 \
passphrase="shared-secret" \
recipient="someone@somewhere.com" <<< "SECRET")
# fetch the secret data
DATA="$(ots_retrieve "$URL")"
# share/generate a new secret, and get back the private metadata key
KEY=$(ots_metashare <<< "SECRET")
KEY=$(ots_metagenerate)
# get a list of private metadata keys recently created.
# note that this requires valid authentication credentials
RECENT=( $(ots_recent) )
# check on the current state of a secret, given the private key
ots_state $KEY
# burn a secret, given the private key
ots_burn $KEY
Terminal window
# Share a secret (from stdin)
./ots share
SECRET
^D
# Share a secret (via HEREDOC)
./ots share <<-EOF
This is a multi-line secret via HEREDOC.
Something else goes here.
EOF
# Get/Retrieve a secret:
./ots get <key|url>
./ots retrieve <key|url>
# Burn a secret, given its private metadata key:
./ots burn <key>